clients

Creates, updates, deletes, gets or lists a clients resource.

Overview

Name	clients
Type	Resource
Id	aws.sso_oidc.clients

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
register_client	insert	region, clientName, clientType		Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant.

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

register_client

Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant.

INSERT INTO aws.sso_oidc.clients (
clientName,
clientType,
scopes,
redirectUris,
grantTypes,
issuerUrl,
entitledApplicationArn,
region
)
SELECT 
'{{ clientName }}' /* required */,
'{{ clientType }}' /* required */,
'{{ scopes }}',
'{{ redirectUris }}',
'{{ grantTypes }}',
'{{ issuerUrl }}',
'{{ entitledApplicationArn }}',
'{{ region }}'
RETURNING
authorization_endpoint,
client_id,
client_id_issued_at,
client_secret,
client_secret_expires_at,
token_endpoint
;

Manifest

# Description fields are for documentation purposes
- name: clients
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the clients resource.
  - name: clientName
    value: "{{ clientName }}"
  - name: clientType
    value: "{{ clientType }}"
  - name: scopes
    value:
      - "{{ scopes }}"
  - name: redirectUris
    value:
      - "{{ redirectUris }}"
  - name: grantTypes
    value:
      - "{{ grantTypes }}"
  - name: issuerUrl
    value: "{{ issuerUrl }}"
  - name: entitledApplicationArn
    value: "{{ entitledApplicationArn }}"