@aws-sdk/client-verifiedpermissions

IsAuthorizedWithTokenCommandInput Interface

The input for IsAuthorizedWithTokenCommand.

Members

Name
Type
Details
policyStoreId Requiredstring | undefined

Specifies the ID of the policy store. Policies in this policy store will be used to make an authorization decision for the input.

accessToken string | undefined

Specifies an access token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an access token. Verified Permissions returns an error if the token_use claim in the submitted token isn't access.

action ActionIdentifier | undefined

Specifies the requested action to be authorized. Is the specified principal authorized to perform this action on the specified resource.

context ContextDefinition | undefined

Specifies additional context that can be used to make more granular authorization decisions.

entities EntitiesDefinition | undefined

Specifies the list of resources and their associated attributes that Verified Permissions can examine when evaluating the policies.

You can't include principals in this parameter, only resource and action entities. This parameter can't include any entities of a type that matches the user or group entity types that you defined in your identity source.

  • The IsAuthorizedWithToken operation takes principal attributes from only the identityToken or accessToken passed to the operation.

  • For action entities, you can include only their Identifier and EntityType.

identityToken string | undefined

Specifies an identity token for the principal to be authorized. This token is provided to you by the identity provider (IdP) associated with the specified identity source. You must specify either an accessToken, an identityToken, or both.

Must be an ID token. Verified Permissions returns an error if the token_use claim in the submitted token isn't id.

resource EntityIdentifier | undefined

Specifies the resource for which the authorization decision is made. For example, is the principal allowed to perform the action on the resource?

Full Signature

export interface IsAuthorizedWithTokenCommandInput extends IsAuthorizedWithTokenInput