AddClientIDToOpenIDConnectProvider
Adds a new client ID (also known as audience) to the list of client IDs already registered for the specified IAM OpenID Connect (OIDC) provider resource.
This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- ClientID
-
The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- OpenIDConnectProviderArn
-
The Amazon Resource Name (ARN) of the IAM OpenID Connect (OIDC) provider resource to add the client ID to. You can get a list of OIDC provider ARNs by using the ListOpenIDConnectProviders operation.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidInput
-
The request was rejected because an invalid or out-of-range value was supplied for an input parameter.
HTTP Status Code: 400
- LimitExceeded
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
HTTP Status Code: 409
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of AddClientIDToOpenIDConnectProvider.
Sample Request
https://iam.amazonaws.com/?Action=AddClientIDToOpenIDConnectProvider
&ClientID=my-application-ID
&OpenIDConnectProviderArn=arn:aws:iam::123456789012:oidc-provider/server.example.com
&Version=2010-05-08
&AUTHPARAMSSample Response
<AddClientIDToOpenIDConnectProviderResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>e4bdcdae-4f66-11e4-aefa-bfd6aEXAMPLE</RequestId>
</ResponseMetadata>
</AddClientIDToOpenIDConnectProviderResponse>See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
