Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

UpdateResourceServer

Updates the name and scopes of a resource server. All other fields are read-only. For more information about resource servers, see Access control with resource servers.

Important

If you don't provide a value for an attribute, it is set to the default value.

Note

Amazon Cognito evaluates AWS 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.

Learn more

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 like https://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

The updated name of the resource server.

Type: String

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

Pattern: [\w\s+=,.@-]+

Required: Yes

Scopes

An array of updated custom scope names and descriptions that you want to associate with your resource server.

Type: Array of ResourceServerScopeType objects

Array Members: Maximum number of 100 items.

Required: No

UserPoolId

The ID of the user pool that contains the resource server that you want to update.

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 updated details of the requested 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

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

Examples

Example

The following example request adds two scopes to the requested resource server.

Sample Request


POST HTTP/1.1
Host: cognito-idp.us-west-2.amazonaws.com
X-Amz-Date: 20230613T200059Z
Accept-Encoding: gzip, deflate, br
X-Amz-Target: AWSCognitoIdentityProviderService.UpdateResourceServer
User-Agent: <UserAgentString>
Authorization: AWS4-HMAC-SHA256 Credential=<Credential>, SignedHeaders=<Headers>, Signature=<Signature>
Content-Length: <PayloadSizeBytes>
{
   "Identifier": "myapi.example.com",
   "Name": "Example API with custom access control scopes",
   "Scopes": [
      {
         "ScopeDescription": "International customers",
         "ScopeName": "international.read"
      },
      {
         "ScopeDescription": "Domestic customers",
         "ScopeName": "domestic.read"
      }
   ],
   "UserPoolId": "us-west-2_EXAMPLE"
}

Sample Response


HTTP/1.1 200 OK
Date: Tue, 13 Jun 2023 20:00:59 GMT
Content-Type: application/x-amz-json-1.0
Content-Length: <PayloadSizeBytes>
x-amzn-requestid: a1b2c3d4-e5f6-a1b2-c3d4-EXAMPLE11111
Connection: keep-alive
{
	"ResourceServer": {
		"Identifier": "myapi.example.com",
		"Name": "Example API with custom access control scopes",
		"Scopes": [
			{
				"ScopeDescription": "International customers",
				"ScopeName": "international.read"
			},
			{
				"ScopeDescription": "Domestic customers",
				"ScopeName": "domestic.read"
			}
		],
		"UserPoolId": "us-west-2_EXAMPLE"
	}
}