iam_add_client_id_to_open_id_connect_provider: Adds a new client ID (also known as audience) to the list of...

Description Usage Arguments Details Request syntax Examples

View source: R/iam_operations.R

Description

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.

Usage

1
2
iam_add_client_id_to_open_id_connect_provider(OpenIDConnectProviderArn,
  ClientID)

Arguments

OpenIDConnectProviderArn

[required] 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.

ClientID

[required] The client ID (also known as audience) to add to the IAM OpenID Connect provider resource.

Details

This operation is idempotent; it does not fail or return an error if you add an existing client ID to the provider.

Request syntax

1
2
3
4
svc$add_client_id_to_open_id_connect_provider(
  OpenIDConnectProviderArn = "string",
  ClientID = "string"
)

Examples

1
2
3
4
5
6
7
# The following add-client-id-to-open-id-connect-provider command adds the
# client ID my-application-ID to the OIDC provider named
# server.example.com:
svc$add_client_id_to_open_id_connect_provider(
  ClientID = "my-application-ID",
  OpenIDConnectProviderArn = "arn:aws:iam::123456789012:oidc-provider/server.example.com"
)

paws.security.identity documentation built on Oct. 30, 2019, 11:26 a.m.