Update Resource Server

cognitoidentityprovider_update_resource_server

R Documentation

Updates the name and scopes of a resource server¶

Description¶

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.

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

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

Usage¶

cognitoidentityprovider_update_resource_server(UserPoolId, Identifier,
  Name, Scopes)

Arguments¶

UserPoolId

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

Identifier

[required] 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.

Name

[required] The updated name of the resource server.

Scopes

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

Value¶

A list with the following syntax:

list(
  ResourceServer = list(
    UserPoolId = "string",
    Identifier = "string",
    Name = "string",
    Scopes = list(
      list(
        ScopeName = "string",
        ScopeDescription = "string"
      )
    )
  )
)

Request syntax¶

svc$update_resource_server(
  UserPoolId = "string",
  Identifier = "string",
  Name = "string",
  Scopes = list(
    list(
      ScopeName = "string",
      ScopeDescription = "string"
    )
  )
)