Class: Aws::CognitoIdentityProvider::Types::DcrConfigurationType
- Inherits:
-
Struct
- Object
- Struct
- Aws::CognitoIdentityProvider::Types::DcrConfigurationType
- Defined in:
- gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb
Overview
The dynamic client registration configuration for a user pool. Dynamic client registration lets applications register their own app clients at runtime through the registration endpoint of your user pool domain. To activate this setting, your user pool must be in the Essentials tier or higher.
Applications register app clients at the /oauth2/register endpoint
of your user pool domain. In authenticated registration, the
application sends an access token from your user pool that has the
aws.cognito/dcr/register scope. In open registration, the
application doesn't send a token.
When you include this configuration in an UpdateUserPool request,
Amazon Cognito replaces the existing configuration with the one that
you provide.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#allowed_scopes ⇒ Array<String>
The scopes that an app client created through dynamic client registration can request, in addition to the standard OpenID Connect (OIDC) scopes.
-
#authenticated_grant_types ⇒ Array<String>
The OAuth grant types that an app client created through authenticated registration can request.
-
#enable_status ⇒ String
Specifies whether dynamic client registration is turned on for the user pool.
-
#open_dcr_enabled ⇒ Boolean
Specifies whether open registration is turned on.
-
#open_dcr_grant_types ⇒ Array<String>
The OAuth grant types that an app client created through open registration can request.
Instance Attribute Details
#allowed_scopes ⇒ Array<String>
The scopes that an app client created through dynamic client
registration can request, in addition to the standard OpenID Connect
(OIDC) scopes. You can include custom scopes from your resource
servers and aws.cognito.signin.user.admin. Registered app clients
can request the OIDC scopes openid, email, phone, and
profile without listing them here. If you don't set this value,
registered app clients can request only the OIDC scopes. A
registered app client can't request the aws.cognito/dcr/register
scope, even if you include it in this list.
5773 5774 5775 5776 5777 5778 5779 5780 5781 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5773 class DcrConfigurationType < Struct.new( :enable_status, :open_dcr_enabled, :authenticated_grant_types, :open_dcr_grant_types, :allowed_scopes) SENSITIVE = [] include Aws::Structure end |
#authenticated_grant_types ⇒ Array<String>
The OAuth grant types that an app client created through
authenticated registration can request. If you don't set this
value, authenticated registration permits the code and
client_credentials grant types. If you set an empty list, Amazon
Cognito rejects authenticated registration requests. Dynamic client
registration supports the following values. Amazon Cognito accepts
implicit in this list but ignores it.
- code
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/tokenendpoint.- client_credentials
Issue the access token from the
/oauth2/tokenendpoint directly to a non-person user using a combination of the client ID and client secret.
5773 5774 5775 5776 5777 5778 5779 5780 5781 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5773 class DcrConfigurationType < Struct.new( :enable_status, :open_dcr_enabled, :authenticated_grant_types, :open_dcr_grant_types, :allowed_scopes) SENSITIVE = [] include Aws::Structure end |
#enable_status ⇒ String
Specifies whether dynamic client registration is turned on for the user pool. If you provide a dynamic client registration configuration without this value, Amazon Cognito turns dynamic client registration on.
5773 5774 5775 5776 5777 5778 5779 5780 5781 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5773 class DcrConfigurationType < Struct.new( :enable_status, :open_dcr_enabled, :authenticated_grant_types, :open_dcr_grant_types, :allowed_scopes) SENSITIVE = [] include Aws::Structure end |
#open_dcr_enabled ⇒ Boolean
Specifies whether open registration is turned on. When open
registration is on, applications can register app clients without an
initial access token. The default value is false.
5773 5774 5775 5776 5777 5778 5779 5780 5781 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5773 class DcrConfigurationType < Struct.new( :enable_status, :open_dcr_enabled, :authenticated_grant_types, :open_dcr_grant_types, :allowed_scopes) SENSITIVE = [] include Aws::Structure end |
#open_dcr_grant_types ⇒ Array<String>
The OAuth grant types that an app client created through open
registration can request. If you don't set this value, open
registration permits only the code grant type. If you set an empty
list, Amazon Cognito rejects open registration requests. If you add
client_credentials, anyone can register an app client that
requests machine-to-machine (M2M) access tokens, and you pay for the
M2M token requests that those app clients make. Dynamic client
registration supports the following values. Amazon Cognito accepts
implicit in this list but ignores it.
- code
Use a code grant flow, which provides an authorization code as the response. This code can be exchanged for access tokens with the
/oauth2/tokenendpoint.- client_credentials
Issue the access token from the
/oauth2/tokenendpoint directly to a non-person user using a combination of the client ID and client secret.
5773 5774 5775 5776 5777 5778 5779 5780 5781 |
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 5773 class DcrConfigurationType < Struct.new( :enable_status, :open_dcr_enabled, :authenticated_grant_types, :open_dcr_grant_types, :allowed_scopes) SENSITIVE = [] include Aws::Structure end |