DisassociateIdentityProviderConfig - Amazon EKS

DisassociateIdentityProviderConfig

Disassociates an identity provider configuration from a cluster. If you disassociate an identity provider from your cluster, users included in the provider can no longer access the cluster. However, you can still access the cluster with AWS IAM users.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.

name

The name of the cluster to disassociate an identity provider from.

Required: Yes

Request Body

The request accepts the following data in JSON format.

clientRequestToken

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Required: No

identityProviderConfig

An object that represents an identity provider configuration.

Type: IdentityProviderConfig object

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "update": { "createdAt": number, "errors": [ { "errorCode": "string", "errorMessage": "string", "resourceIds": [ "string" ] } ], "id": "string", "params": [ { "type": "string", "value": "string" } ], "status": "string", "type": "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.

update

An object representing an asynchronous update.

Type: Update 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 a user that doesn't have permissions to use the action or resource or specifying an identifier that is not valid.

HTTP Status Code: 400

InvalidParameterException

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

HTTP Status Code: 400

InvalidRequestException

The request is invalid given the state of the cluster. Check the state of the cluster and the associated operations.

HTTP Status Code: 400

ResourceInUseException

The specified resource is in use.

HTTP Status Code: 409

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 Region-specific.

HTTP Status Code: 404

ServerException

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

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon EKS General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

The following example disassociates an OIDC identity provider named my-config from a cluster.

Sample Request

POST /clusters/oidc2/identity-provider-configs/disassociate HTTP/1.1 Host: eks.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20201215T211826Z Authorization: AUTHPARAMS Content-Length: 127 { "identityProviderConfig": { "type": "oidc", "name": "my-config" }, "clientRequestToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" }

Sample Response

HTTP/1.1 200 OK Date: Tue, 15 Dec 2020 21:18:27 GMT Content-Type: application/json Content-Length: 297 x-amzn-RequestId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx x-amz-apigw-id: XnM1dE8TvHcFn8Q= X-Amzn-Trace-Id: Root=1-xxxxxxxxx-xxxxxxxxxxxxxxxxxxxxxxxx Connection: keep-alive { "update" : { "id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "status" : "InProgress", "type" : "DisassociateIdentityProviderConfig", "params" : [ { "type" : "IdentityProviderConfig", "value" : "[]" } ], "createdAt" : 1.60806710785E9, "errors" : [ ] } }

See Also

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