UpdateTrustedTokenIssuerCommand

Suggest an Edit

Updates the name of the trusted token issuer, or the path of a source attribute or destination attribute for a trusted token issuer configuration.

Updating this trusted token issuer configuration might cause users to lose access to any applications that are configured to use the trusted token issuer.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SSOAdminClient, UpdateTrustedTokenIssuerCommand } from "@aws-sdk/client-sso-admin"; // ES Modules import
// const { SSOAdminClient, UpdateTrustedTokenIssuerCommand } = require("@aws-sdk/client-sso-admin"); // CommonJS import
const client = new SSOAdminClient(config);
const input = { // UpdateTrustedTokenIssuerRequest
  TrustedTokenIssuerArn: "STRING_VALUE", // required
  Name: "STRING_VALUE",
  TrustedTokenIssuerConfiguration: { // TrustedTokenIssuerUpdateConfiguration Union: only one key present
    OidcJwtConfiguration: { // OidcJwtUpdateConfiguration
      ClaimAttributePath: "STRING_VALUE",
      IdentityStoreAttributePath: "STRING_VALUE",
      JwksRetrievalOption: "OPEN_ID_DISCOVERY",
    },
  },
};
const command = new UpdateTrustedTokenIssuerCommand(input);
const response = await client.send(command);
// {};

UpdateTrustedTokenIssuerCommand Input

See UpdateTrustedTokenIssuerCommandInput for more details

Parameter
Type
Description
TrustedTokenIssuerArn
Required
string | undefined

Specifies the ARN of the trusted token issuer configuration that you want to update.

Name
string | undefined

Specifies the updated name to be applied to the trusted token issuer configuration.

TrustedTokenIssuerConfiguration
TrustedTokenIssuerUpdateConfiguration | undefined

Specifies a structure with settings to apply to the specified trusted token issuer. The settings that you can provide are determined by the type of the trusted token issuer that you are updating.

UpdateTrustedTokenIssuerCommand Output

See UpdateTrustedTokenIssuerCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

You do not have sufficient access to perform this action.

ConflictException
client

Occurs when a conflict with a previous successful write is detected. This generally occurs when the previous write did not have time to propagate to the host serving the current request. A retry (with appropriate backoff logic) is the recommended response to this exception.

InternalServerException
server

The request processing has failed because of an unknown error, exception, or failure with an internal server.

ResourceNotFoundException
client

Indicates that a requested resource is not found.

ThrottlingException
client

Indicates that the principal has crossed the throttling limits of the API operations.

ValidationException
client

The request failed because it contains a syntax error.

SSOAdminServiceException
Base exception class for all service exceptions from SSOAdmin service.