Skip to content

Describe Resource Server

cognitoidentityprovider_describe_resource_server R Documentation

Describes a resource server

Description

Describes a resource server.

Usage

cognitoidentityprovider_describe_resource_server(UserPoolId, Identifier)

Arguments

UserPoolId

[required] The user pool ID for the user pool that hosts the 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.

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$describe_resource_server(
  UserPoolId = "string",
  Identifier = "string"
)