DescribeIdentityProviderConfig - Amazon EKS


Describes an identity provider configuration.

Request Syntax

POST /clusters/name/identity-provider-configs/describe HTTP/1.1 Content-type: application/json { "identityProviderConfig": { "name": "string", "type": "string" } }

URI Request Parameters

The request uses the following URI parameters.


The name of your cluster.

Required: Yes

Request Body

The request accepts the following data in JSON format.


An object representing an identity provider configuration.

Type: IdentityProviderConfig object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "identityProviderConfig": { "oidc": { "clientId": "string", "clusterName": "string", "groupsClaim": "string", "groupsPrefix": "string", "identityProviderConfigArn": "string", "identityProviderConfigName": "string", "issuerUrl": "string", "requiredClaims": { "string" : "string" }, "status": "string", "tags": { "string" : "string" }, "usernameClaim": "string", "usernamePrefix": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The object that represents an OpenID Connect (OIDC) identity provider configuration.

Type: IdentityProviderConfigResponse object


For information about the errors that are common to all actions, see Common Errors.


These errors are usually caused by a client action. Actions can include using an action or resource on behalf of an IAM principal that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

HTTP Status Code: 400


The specified parameter is invalid. Review the available parameters for the API request.

HTTP Status Code: 400


The specified resource could not be found. You can view your available clusters with ListClusters. You can view your available managed node groups with ListNodegroups. Amazon EKS clusters and node groups are AWS Region specific.

HTTP Status Code: 404


These errors are usually caused by a server-side issue.

HTTP Status Code: 500


The service is unavailable. Back off and retry the operation.

HTTP Status Code: 503

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: