ResourceServerScopeType - Amazon Cognito User Pools

ResourceServerScopeType

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.

This data type is a request parameter of CreateResourceServer and a response parameter of DescribeResourceServer.

Contents

ScopeDescription

A friendly description of a custom scope.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

ScopeName

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [\x21\x23-\x2E\x30-\x5B\x5D-\x7E]+

Required: Yes

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: