Amazon Cognito · JSON Structure

User Pools Create Resource Server Request Structure

CreateResourceServerRequest schema from Amazon Cognito API

Type: object Properties: 4 Required: 3
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

CreateResourceServerRequest is a JSON Structure definition published by Amazon Cognito, describing 4 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

UserPoolId Identifier Name Scopes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-structure/user-pools-create-resource-server-request-structure.json",
  "name": "CreateResourceServerRequest",
  "description": "CreateResourceServerRequest schema from Amazon Cognito API",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool."
        }
      ]
    },
    "Identifier": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceServerIdentifierType"
        },
        {
          "description": "A unique resource server identifier for the resource server. This could be an HTTPS endpoint where the resource server is located, such as <code>https://my-weather-api.example.com</code>."
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceServerNameType"
        },
        {
          "description": "A friendly name for the resource server."
        }
      ]
    },
    "Scopes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceServerScopeListType"
        },
        {
          "description": "A list of scopes. Each scope is a key-value map with the keys <code>name</code> and <code>description</code>."
        }
      ]
    }
  },
  "required": [
    "UserPoolId",
    "Identifier",
    "Name"
  ]
}