o_auth2_token_with_iams

Creates, updates, deletes, gets or lists an o_auth2_token_with_iams resource.

Overview

Name	o_auth2_token_with_iams
Type	Resource
Id	aws.signin.o_auth2_token_with_iams

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_o_auth2_token_with_iam	insert	region, grantType, resource		Grants permission to exchange client credentials for an OAuth 2.0 access token scoped to a resource that can be used to access AWS services from applications
revoke_o_auth2_token_with_iam	update	region, token		Grants permission to revoke an OAuth 2.0 refresh token and its associated refresh tokens Revokes a refresh_token issued by AWS Sign-In, invalidating the entire token chain so that the refresh_token can no longer be used to mint new access_tokens. Idempotency: revoking an already-revoked, expired, or otherwise invalid token still returns 200 OK with an empty body. Only the refresh_token type is accepted.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

INSERT examples

create_o_auth2_token_with_iam

Grants permission to exchange client credentials for an OAuth 2.0 access token scoped to a resource that can be used to access AWS services from applications

INSERT INTO aws.signin.o_auth2_token_with_iams (
grantType,
resource,
region
)
SELECT 
'{{ grantType }}' /* required */,
'{{ resource }}' /* required */,
'{{ region }}'
RETURNING
access_token,
expires_in,
token_type
;

Manifest

# Description fields are for documentation purposes
- name: o_auth2_token_with_iams
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the o_auth2_token_with_iams resource.
  - name: grantType
    value: "{{ grantType }}"
    description: |
      OAuth 2.0 grant type for client_credentials flow.
  - name: resource
    value: "{{ resource }}"

UPDATE examples

revoke_o_auth2_token_with_iam

Grants permission to revoke an OAuth 2.0 refresh token and its associated refresh tokens Revokes a refresh_token issued by AWS Sign-In, invalidating the entire token chain so that the refresh_token can no longer be used to mint new access_tokens. Idempotency: revoking an already-revoked, expired, or otherwise invalid token still returns 200 OK with an empty body. Only the refresh_token type is accepted.

UPDATE aws.signin.o_auth2_token_with_iams
SET 
token = '{{ token }}'
WHERE 
region = '{{ region }}' --required
AND token = '{{ token }}' --required;