Create Resource Server

cognitoidentityprovider_create_resource_server

R Documentation

Creates a new OAuth2

Description

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.

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

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

Usage

cognitoidentityprovider_create_resource_server(UserPoolId, Identifier,
  Name, Scopes)

Arguments

UserPoolId

[required] The ID of the user pool where you want to create a resource server.

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] A friendly name for the resource server.

Scopes

A list of custom scopes. Each scope is a key-value map with the keys ScopeName and ScopeDescription. The name of a custom scope is a combination of ScopeName and the resource server Name in this request, for example MyResourceServerName/MyScopeName.

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$create_resource_server(
  UserPoolId = "string",
  Identifier = "string",
  Name = "string",
  Scopes = list(
    list(
      ScopeName = "string",
      ScopeDescription = "string"
    )
  )
)