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.

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 user pool ID for the user pool.

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 scopes. Each scope is a key-value map with the keys name and description.

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"
    )
  )
)