CreateResourceServer
Creates a new OAuth2.0 resource server and defines custom scopes within it. Resource servers are associated with custom scopes and machine-to-machine (M2M) authorization. For more information, see Access control with resource servers.
Note
Amazon Cognito evaluates Amazon Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.
Request Syntax
{
"Identifier": "string
",
"Name": "string
",
"Scopes": [
{
"ScopeDescription": "string
",
"ScopeName": "string
"
}
],
"UserPoolId": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Identifier
-
A unique resource server identifier for the resource server. The identifier can be an API friendly name like
solar-system-data
. You can also set an API URL likehttps://solar-system-data-api.example.com
as your identifier.Amazon Cognito represents scopes in the access token in the format
$resource-server-identifier/$scope
. Longer scope-identifier strings increase the size of your access tokens.Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\x21\x23-\x5B\x5D-\x7E]+
Required: Yes
- Name
-
A friendly name for the resource server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
[\w\s+=,.@-]+
Required: Yes
- Scopes
-
A list of custom scopes. Each scope is a key-value map with the keys
ScopeName
andScopeDescription
. The name of a custom scope is a combination ofScopeName
and the resource serverName
in this request, for exampleMyResourceServerName/MyScopeName
.Type: Array of ResourceServerScopeType objects
Array Members: Maximum number of 100 items.
Required: No
- UserPoolId
-
The ID of the user pool where you want to create a resource server.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 55.
Pattern:
[\w-]+_[0-9a-zA-Z]+
Required: Yes
Response Syntax
{
"ResourceServer": {
"Identifier": "string",
"Name": "string",
"Scopes": [
{
"ScopeDescription": "string",
"ScopeName": "string"
}
],
"UserPoolId": "string"
}
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ResourceServer
-
The details of the new resource server.
Type: ResourceServerType object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalErrorException
-
This exception is thrown when Amazon Cognito encounters an internal error.
HTTP Status Code: 500
- InvalidParameterException
-
This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
HTTP Status Code: 400
- LimitExceededException
-
This exception is thrown when a user exceeds the limit for a requested Amazon resource.
HTTP Status Code: 400
- NotAuthorizedException
-
This exception is thrown when a user isn't authorized.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when the Amazon Cognito service can't find the requested resource.
HTTP Status Code: 400
- TooManyRequestsException
-
This exception is thrown when the user has made too many requests for a given operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: