Skip to main content

​
Schema

​
Optional

  • active (Boolean, Deprecated) Specifies if the federation in active state
  • labels (Map of String) Labels associated with the resource.
  • metadata (Attributes) : Federation resource metadata.

    ​
    Inner value description

    Common resource metadata. (see below for nested schema)
  • name (String) Human readable name for the resource.
  • parent_id (String) Identifier of the parent resource to which the resource belongs.
  • saml_settings (Attributes) SAML federation settings. (see below for nested schema)
  • user_account_auto_creation (Boolean) : If false, users with access to the federation cannot sign in automatically and user accounts for them must be pre-created by a federation administrator.

​
Read-Only

  • created_at (String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM
  • id (String) Identifier for the resource, unique for its resource type.
  • labels_all (Map of String) Effective labels sent to the API after merging provider default_labels with resource labels.
  • resource_version (Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current.
  • status (Attributes) Federation resource status. (see below for nested schema)
  • updated_at (String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ or YYYY-MM-DDTHH:MM:SS.SSS±HH:MM

​
Nested Schema for metadata

​
Nested Schema for saml_settings

Optional:
  • force_authn (Boolean) : If true, the SAML AuthnRequest asks the identity provider to authenticate the user instead of reusing an existing IdP session. (See SAML Core 2.0, section 3.4.1, ForceAuthn: https://docs.oasis-open.org/security/saml/v2.0/saml-core-2.0-os.pdf) Limitations: the SAML response does not let verify whether the identity provider honored this request; support depends on the identity provider.
  • idp_issuer (String) The unique identifier of the SAML Identity Provider. It usually matches the entityID from the IdP metadata.
  • sso_url (String) Identity Provider’s Single Sign-On endpoint. This is the URL where the user is redirected to start SAML login.

​
Nested Schema for status

Read-Only:
  • certificates_count (Number) Number of certificates attached to the SAML federation for verifying SAML responses.
  • state (String) : Federation state.

    ​
    Supported values

    Possible values:
    • UNSPECIFIED
    • ACTIVE
    • INACTIVE
  • users_count (Number) Number of users registered in the IAM federation. This value may differ from the number of users in the identity provider.