/ - Amazon Cognito Identity Provider

Updates the name and scopes of resource server. All other fields are read-only.

curl --location --request POST '/' \ --header 'X-Amz-Target;' \ --header 'Content-Type: application/json' \ --data-raw '{ "UserPoolId": "string", "Identifier": "string", "Name": "string", "Scopes": [] }'

Request

Header Params

X-Amz-Target

string

required

Body Params application/json

UserPoolId

string

required

The user pool ID for the user pool.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

Identifier

string

required

The identifier for the resource server.

>= 1 characters<= 256 characters

Match pattern:

[\x21\x23-\x5B\x5D-\x7E]+

Name

string

required

The name of the resource server.

>= 1 characters<= 256 characters

Match pattern:

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

Scopes

array[object (ResourceServerScopeType) {2}]

optional

The scope values to be set for the resource server.

<= 100 items

ScopeName

string

required

The name of the scope.

>= 1 characters<= 256 characters

Match pattern:

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

ScopeDescription

string

required

A description of the scope.

>= 1 characters<= 256 characters

Examples

Responses

🟢200Success

application/json

Body

ResourceServer

object

required

The resource server.

UserPoolId

string

optional

The user pool ID for the user pool that hosts the resource server.

>= 1 characters<= 55 characters

Match pattern:

[\w-]+_[0-9a-zA-Z]+

Identifier

string

optional

The identifier for the resource server.

>= 1 characters<= 256 characters

Match pattern:

[\x21\x23-\x5B\x5D-\x7E]+

Name

string

optional

The name of the resource server.

>= 1 characters<= 256 characters

Match pattern:

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

Scopes

array[object (ResourceServerScopeType) {2}]

optional

A list of scopes that are defined for the resource server.

<= 100 items

🟠480InvalidParameterException

🟠481ResourceNotFoundException

🟠482NotAuthorizedException

🟠483TooManyRequestsException

🟠484InternalErrorException