Class: Aws::CognitoIdentityProvider::Types::ResourceServerScopeType

Inherits:

Struct

Object
Struct
Aws::CognitoIdentityProvider::Types::ResourceServerScopeType

show all

Defined in:: gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

One custom scope associated with a user pool resource server. This data type is a member of ResourceServerScopeType. For more information, see Scopes, M2M, and API authorization with resource servers.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#scope_description ⇒ String
A friendly description of a custom scope.
#scope_name ⇒ String
The name of the scope.

Instance Attribute Details

#scope_description ⇒ `String`

A friendly description of a custom scope.

Returns:

(String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 8847

class ResourceServerScopeType < Struct.new(
  :scope_name,
  :scope_description)
  SENSITIVE = []
  include Aws::Structure
end

#scope_name ⇒ `String`

The name of the scope. Amazon Cognito renders custom scopes in the format resourceServerIdentifier/ScopeName. For example, if this parameter is exampleScope in the resource server with the identifier exampleResourceServer, you request and receive the scope exampleResourceServer/exampleScope.