Class: Aws::SSOOIDC::Types::RegisterClientRequest

Inherits:

Struct

• Object
• Struct
• Aws::SSOOIDC::Types::RegisterClientRequest

Defined in:

gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #client_name ⇒ String

  The friendly name of the client.

• #client_type ⇒ String

  The type of client.

• #entitled_application_arn ⇒ String

  This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources.

• #grant_types ⇒ Array<String>

  The list of OAuth 2.0 grant types that are defined by the client.

• #issuer_url ⇒ String

  The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center.

• #redirect_uris ⇒ Array<String>

  The list of redirect URI that are defined by the client.

• #scopes ⇒ Array<String>

  The list of scopes that are defined by the client.

Instance Attribute Details

#client_name ⇒ String

The friendly name of the client.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 672

class RegisterClientRequest < Struct.new(
  :client_name,
  :client_type,
  :scopes,
  :redirect_uris,
  :grant_types,
  :issuer_url,
  :entitled_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#client_type ⇒ String

The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 672

class RegisterClientRequest < Struct.new(
  :client_name,
  :client_type,
  :scopes,
  :redirect_uris,
  :grant_types,
  :issuer_url,
  :entitled_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#entitled_application_arn ⇒ String

This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 672

class RegisterClientRequest < Struct.new(
  :client_name,
  :client_type,
  :scopes,
  :redirect_uris,
  :grant_types,
  :issuer_url,
  :entitled_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#grant_types ⇒ Array<String>

The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client. Supports the following OAuth 2.0 grant types: Authorization Code, Device Code, and Refresh Token.

• Authorization Code - authorization_code

• Device Code - urn:ietf:params:oauth:grant-type:device_code

• Refresh Token - refresh_token

Returns:

• (Array<String>)

# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 672

class RegisterClientRequest < Struct.new(
  :client_name,
  :client_type,
  :scopes,
  :redirect_uris,
  :grant_types,
  :issuer_url,
  :entitled_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#issuer_url ⇒ String

The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.

Returns:

• (String)

# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 672

class RegisterClientRequest < Struct.new(
  :client_name,
  :client_type,
  :scopes,
  :redirect_uris,
  :grant_types,
  :issuer_url,
  :entitled_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_uris ⇒ Array<String>

The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 672

class RegisterClientRequest < Struct.new(
  :client_name,
  :client_type,
  :scopes,
  :redirect_uris,
  :grant_types,
  :issuer_url,
  :entitled_application_arn)
  SENSITIVE = []
  include Aws::Structure
end

#scopes ⇒ Array<String>

The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-core/lib/aws-sdk-ssooidc/types.rb', line 672

class RegisterClientRequest < Struct.new(
  :client_name,
  :client_type,
  :scopes,
  :redirect_uris,
  :grant_types,
  :issuer_url,
  :entitled_application_arn)
  SENSITIVE = []
  include Aws::Structure
end