Developer Documentation

ProvidersCreateSpec

The Providers.CreateSpec structure contains the information used to create an identity provider.


Properties

Required Property Name Type Description
optional active_directory_over_ldap ProvidersActiveDirectoryOverLdap

Identity management configuration. If the protocol is LDAP, the configuration must be set, else InvalidArgument is thrown. This field is optional and it is only relevant when the value of Providers.CreateSpec.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.

If unset, the map will be empty.

required config_tag ProvidersConfigType 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 unset, domainNames will be the empty set and the 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.

optional groups_claim string

Specifies which claim provides the group membership for the token subject. These groups will be used for mapping to local groups per the claim map. If unset, the default behavior will be CSP backwards compatiblility. The groups for the subject will be comprised of the groups in ‘group_names’ and ‘group_ids’ claims.

optional idm_endpoints array of string

Identity management endpoints. When specified, at least one endpoint must be provided. This field is optional and it is only relevant when the value of Providers.CreateSpec.idm-protocol is one of REST or SCIM.

optional idm_protocol ProvidersIdmProtocol Enum

Communication protocol to the identity management endpoints. If unset, no communication protocol will be configured for the identity provider.

optional is_default boolean

Specifies whether the provider is the default provider. Setting Providers.CreateSpec.is-default of current provider to True makes all other providers non-default. If no other providers created in this vCenter Server before, this parameter will be disregarded, and the provider will always be set to the default. If unset the provider will be the default provider if it is the first provider that is created, and will not be the default provider otherwise.

optional name string

The user friendly name for the provider. This name can be used for human-readable identification purposes, but it does not have to be unique, as the system will use internal UUIDs to differentiate providers. If unset, the name will be the empty string

optional oauth2 ProvidersOauth2CreateSpec

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

optional oidc ProvidersOidcCreateSpec

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

optional org_ids array of string

The set of orgIds as part of SDDC creation which provides the basis for tenancy If unset, the set will be empty.

optional upn_claim string

Specifies which claim provides the user principal name (UPN) for the user. If unset, the claim named ‘acct’ will be used to provide backwards compatibility with CSP.

Feedback

Was this page helpful?