vcenter identity providers: info
info
structure contains the information about an identity provider. This structure was added in vSphere API 7.0.0.0.Representation:
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
-.org_ids | string[] | The set of orgIds as part of SDDC creation which provides the basis for tenancy. This attribute was added in vSphere API 7.0.0.0.
|
-.config_tag | string | The config type of the identity provider. This attribute was added in vSphere API 7.0.0.0. The |
-.oauth2.auth_endpoint | URI | Authentication/authorization endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oauth2.token_endpoint | URI | Token endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oauth2.public_key_uri | URI | Endpoint to retrieve the provider public key for validation. This attribute was added in vSphere API 7.0.0.0.
|
-.oauth2.client_id | string | Client identifier to connect to the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oauth2.client_secret | string | The secret shared between the client and the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oauth2.claim_map | object | The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key "perms" is supported. The key "perms" is used for mapping the "perms" claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. This attribute was added in vSphere API 7.0.0.0. Object with element values of type object. |
-.oauth2.issuer | string | The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. This attribute was added in vSphere API 7.0.0.0.
|
-.oauth2.authentication_method | string | Authentication method used by the provider. This attribute was added in vSphere API 7.0.0.0. The |
-.oauth2.auth_query_params | object | 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:
Object with element values of type string[]. |
-.oidc.discovery_endpoint | URI | Endpoint to retrieve the provider metadata. This attribute was added in vSphere API 7.0.0.0.
|
-.oidc.auth_endpoint | URI | Authentication/authorization endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oidc.token_endpoint | URI | Token endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oidc.public_key_uri | URI | Endpoint to retrieve the provider public key for validation. This attribute was added in vSphere API 7.0.0.0.
|
-.oidc.client_id | string | Client identifier to connect to the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oidc.client_secret | string | The secret shared between the client and the provider. This attribute was added in vSphere API 7.0.0.0.
|
-.oidc.claim_map | object | The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key "perms" is supported. The key "perms" is used for mapping the "perms" claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. This attribute was added in vSphere API 7.0.0.0. Object with element values of type object. |
-.oidc.issuer | string | The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. This attribute was added in vSphere API 7.0.0.0.
|
-.oidc.authentication_method | string | Authentication method used by the provider. This attribute was added in vSphere API 7.0.0.0. The |
-.oidc.auth_query_params | object | 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:
Object with element values of type string[]. |
-.is_default | boolean | Specifies whether the provider is the default provider. This attribute was added in vSphere API 7.0.0.0.
|
-.active_directory_over_ldap.user_name | string | User name to connect to the active directory server. This attribute was added in vSphere API 7.0.0.0.
|
-.active_directory_over_ldap.password | secret | Password to connect to the active directory server. This attribute was added in vSphere API 7.0.0.0.
|
-.active_directory_over_ldap.users_base_dn | string | Base distinguished name for users. This attribute was added in vSphere API 7.0.0.0.
|
-.active_directory_over_ldap.groups_base_dn | string | Base distinguished name for groups. This attribute was added in vSphere API 7.0.0.0.
|
-.active_directory_over_ldap.server_endpoints | URI[] | Active directory server endpoints. At least one active directory server endpoint must be set. This attribute was added in vSphere API 7.0.0.0.
|
-.active_directory_over_ldap.cert_chain.cert_chain | string[] | Certificate chain in base64 format. This attribute was added in vSphere API 6.7.2.
|
Optional | ||
-.name | string | The user friendly name for the provider. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
-.oauth2 | oauth2_info | OAuth2 Info. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when config_tag has value Oauth2. This field is optional and it is only relevant when the value of |
-.oidc | oidc_info | OIDC Info. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when config_tag has value Oidc. This field is optional and it is only relevant when the value of |
-.oidc.logout_endpoint | URI | The endpoint to use for terminating the user's session at the identity provider. This value is automatically derived from the metadata information provided by the OIDC discovery endpoint. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
-.domain_names | 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 attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
-.auth_query_params | object | 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:
Optional. This field is optional because it was added in a newer version than its parent node.Object with element values of type string[]. |
-.idm_protocol | string | Communication protocol to the identity management endpoints. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
-.idm_endpoints | URI[] | Identity management endpoints. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when idm_protocol has value [REST, SCIM, SCIM2_0]. This field is optional and it is only relevant when the value of |
-.active_directory_over_ldap | active_directory_over_ldap | Identity management configuration. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when idm_protocol has value LDAP. This field is optional and it is only relevant when the value of |
-.active_directory_over_ldap.cert_chain | x509_cert_chain | SSL certificate chain in base64 encoding. This attribute was added in vSphere API 7.0.0.0. Optional. This field can be unset only, if all the active directory server endpoints use the LDAP (not LDAPS) protocol. |
-.upn_claim | string | Specifies which claim provides the user principal name (UPN) for the user. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
-.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 attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
org_ids | string[] | The set of orgIds as part of SDDC creation which provides the basis for tenancy. This attribute was added in vSphere API 7.0.0.0.
|
config_tag | string | The config type of the identity provider. This attribute was added in vSphere API 7.0.0.0. The |
oauth2.auth_endpoint | URI | Authentication/authorization endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
oauth2.token_endpoint | URI | Token endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
oauth2.public_key_uri | URI | Endpoint to retrieve the provider public key for validation. This attribute was added in vSphere API 7.0.0.0.
|
oauth2.client_id | string | Client identifier to connect to the provider. This attribute was added in vSphere API 7.0.0.0.
|
oauth2.client_secret | string | The secret shared between the client and the provider. This attribute was added in vSphere API 7.0.0.0.
|
oauth2.claim_map | list | The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key "perms" is supported. The key "perms" is used for mapping the "perms" claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. This attribute was added in vSphere API 7.0.0.0. List of {"key": string, "value": list} |
oauth2.issuer | string | The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. This attribute was added in vSphere API 7.0.0.0.
|
oauth2.authentication_method | string | Authentication method used by the provider. This attribute was added in vSphere API 7.0.0.0. The |
oauth2.auth_query_params | list | 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:
List of {"key": string, "value": string[]} |
oidc.discovery_endpoint | URI | Endpoint to retrieve the provider metadata. This attribute was added in vSphere API 7.0.0.0.
|
oidc.auth_endpoint | URI | Authentication/authorization endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
oidc.token_endpoint | URI | Token endpoint of the provider. This attribute was added in vSphere API 7.0.0.0.
|
oidc.public_key_uri | URI | Endpoint to retrieve the provider public key for validation. This attribute was added in vSphere API 7.0.0.0.
|
oidc.client_id | string | Client identifier to connect to the provider. This attribute was added in vSphere API 7.0.0.0.
|
oidc.client_secret | string | The secret shared between the client and the provider. This attribute was added in vSphere API 7.0.0.0.
|
oidc.claim_map | list | The map used to transform an OAuth2 claim to a corresponding claim that vCenter Server understands. Currently only the key "perms" is supported. The key "perms" is used for mapping the "perms" claim of incoming JWT. The value is another map with an external group as the key and a vCenter Server group as value. This attribute was added in vSphere API 7.0.0.0. List of {"key": string, "value": list} |
oidc.issuer | string | The identity provider namespace. It is used to validate the issuer in the acquired OAuth2 token. This attribute was added in vSphere API 7.0.0.0.
|
oidc.authentication_method | string | Authentication method used by the provider. This attribute was added in vSphere API 7.0.0.0. The |
oidc.auth_query_params | list | 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:
List of {"key": string, "value": string[]} |
is_default | boolean | Specifies whether the provider is the default provider. This attribute was added in vSphere API 7.0.0.0.
|
active_directory_over_ldap.user_name | string | User name to connect to the active directory server. This attribute was added in vSphere API 7.0.0.0.
|
active_directory_over_ldap.password | secret | Password to connect to the active directory server. This attribute was added in vSphere API 7.0.0.0.
|
active_directory_over_ldap.users_base_dn | string | Base distinguished name for users. This attribute was added in vSphere API 7.0.0.0.
|
active_directory_over_ldap.groups_base_dn | string | Base distinguished name for groups. This attribute was added in vSphere API 7.0.0.0.
|
active_directory_over_ldap.server_endpoints | URI[] | Active directory server endpoints. At least one active directory server endpoint must be set. This attribute was added in vSphere API 7.0.0.0.
|
active_directory_over_ldap.cert_chain.cert_chain | string[] | Certificate chain in base64 format. This attribute was added in vSphere API 6.7.2.
|
Optional | ||
name | string | The user friendly name for the provider. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
oauth2 | oauth2_info | OAuth2 Info. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when config_tag has value Oauth2. This field is optional and it is only relevant when the value of |
oidc | oidc_info | OIDC Info. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when config_tag has value Oidc. This field is optional and it is only relevant when the value of |
oidc.logout_endpoint | URI | The endpoint to use for terminating the user's session at the identity provider. This value is automatically derived from the metadata information provided by the OIDC discovery endpoint. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
domain_names | 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 attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
auth_query_params | list | 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:
Optional. This field is optional because it was added in a newer version than its parent node.List of {"key": string, "value": string[]} |
idm_protocol | string | Communication protocol to the identity management endpoints. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
idm_endpoints | URI[] | Identity management endpoints. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when idm_protocol has value [REST, SCIM, SCIM2_0]. This field is optional and it is only relevant when the value of |
active_directory_over_ldap | active_directory_over_ldap | Identity management configuration. This attribute was added in vSphere API 7.0.0.0. Optional. It is only relevant when idm_protocol has value LDAP. This field is optional and it is only relevant when the value of |
active_directory_over_ldap.cert_chain | x509_cert_chain | SSL certificate chain in base64 encoding. This attribute was added in vSphere API 7.0.0.0. Optional. This field can be unset only, if all the active directory server endpoints use the LDAP (not LDAPS) protocol. |
upn_claim | string | Specifies which claim provides the user principal name (UPN) for the user. This attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |
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 attribute was added in vSphere API 7.0.0.0. Optional. This field is optional because it was added in a newer version than its parent node. |