Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DescribeIdentityProviderConfig

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.

name

The name of your cluster.

Required: Yes

Request Body

The request accepts the following data in JSON format.

identityProviderConfig

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.

identityProviderConfig

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

Type: IdentityProviderConfigResponse object

Errors

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

ClientException

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.

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
message: 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.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

InvalidParameterException

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

addonName: The specified parameter for the add-on name is invalid. Review the available parameters for the API request
clusterName: The Amazon EKS cluster associated with the exception.
fargateProfileName: The Fargate profile associated with the exception.
message: The specified parameter is invalid. Review the available parameters for the API request.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 400

ResourceNotFoundException

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.

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
fargateProfileName: The Fargate profile associated with the exception.
message: The Amazon EKS message associated with the exception.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 404

ServerException

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

addonName: The Amazon EKS add-on name associated with the exception.
clusterName: The Amazon EKS cluster associated with the exception.
message: These errors are usually caused by a server-side issue.
nodegroupName: The Amazon EKS managed node group associated with the exception.
subscriptionId: The Amazon EKS subscription ID with the exception.

HTTP Status Code: 500

ServiceUnavailableException

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

message: The request has failed due to a temporary failure of the server.

HTTP Status Code: 503