ResourceServerScopeTypeProperty Struct
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 .
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
const resourceServerScopeTypeProperty: cognito.CfnUserPoolResourceServer.ResourceServerScopeTypeProperty = {
scopeDescription: 'scopeDescription',
scopeName: 'scopeName',
};
Properties
scopeDescriptionstringscope_descriptionstrscopeDescriptionStringScopeDescriptionstringScopeDescription*stringrequired#A friendly description of a custom scope.
The name of the scope.
notes
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 .