IdentityProvidersInfo

The Providers.Info structure contains the information about an identity provider.


Properties

Required Property Name Type Description
optional active_directory_over_ldap IdentityProvidersActiveDirectoryOverLdap

Identity management configuration. This field is optional and it is only relevant when the value of Providers.Info.idm-protocol is LDAP.

optional auth_query_params map of string

key/value pairs that are to be appended to the authEndpoint request.

How to append to authEndpoint request: If the map is not empty, a “?” is added to the endpoint URL, and combination of each k and each string in the v is added with an “&” delimiter. Details: - If the value contains only one string, then the key is added with “k=v”. - If the value is an empty list, then the key is added without a “=v”. - If the value contains multiple strings, then the key is repeated in the query-string for each string in the value.

This field is optional because it was added in a newer version than its parent node.

required config_tag IdentityProvidersConfigType Enum

The config type of the identity provider

optional domain_names array of string

Set of fully qualified domain names to trust when federating with this identity provider. Tokens from this identity provider will only be validated if the user belongs to one of these domains, and any domain-qualified groups in the tokens will be filtered to include only those groups that belong to one of these domains. If domainNames is an empty set, domain validation behavior at login with this identity provider will be as follows: the user’s domain will be parsed from the User Principal Name (UPN) value that is found in the tokens returned by the identity provider. This domain will then be implicitly trusted and used to filter any groups that are also provided in the tokens. This field is optional because it was added in a newer version than its parent node.

optional groups_claim string

Specifies which claim provides the group membership for the token subject. If empty, the default behavior for CSP is used. In this case, the groups for the subject will be comprised of the groups in ‘group_names’ and ‘group_ids’ claims. This field is optional because it was added in a newer version than its parent node.

optional idm_endpoints array of string

Identity management endpoints. This field is optional and it is only relevant when the value of Providers.Info.idm-protocol is one of REST or SCIM.

optional idm_protocol IdentityProvidersIdmProtocol Enum

Communication protocol to the identity management endpoints. This field is optional because it was added in a newer version than its parent node.

required is_default boolean

Specifies whether the provider is the default provider.

optional name string

The user friendly name for the provider This field is optional because it was added in a newer version than its parent node.

optional oauth2 IdentityProvidersOauth2Info

OAuth2 Info This field is optional and it is only relevant when the value of Providers.Info.config-tag is Oauth2.

optional oidc IdentityProvidersOidcInfo

OIDC Info This field is optional and it is only relevant when the value of Providers.Info.config-tag is Oidc.

required org_ids array of string

The set of orgIds as part of SDDC creation which provides the basis for tenancy

optional upn_claim string

Specifies which claim provides the user principal name (UPN) for the user. This field is optional because it was added in a newer version than its parent node.

JSON Example

{
    "config_tag": "enum",
    "is_default": false,
    "org_ids": [
        "string"
    ]
}
Feedback

Was this page helpful?