Amazon Cognito · JSON Structure

User Pools Resource Server Scope Type Structure

A resource server scope.

Type: object Properties: 2 Required: 2
AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

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

Properties

ScopeName ScopeDescription

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-resource-server-scope-type-structure.json",
  "name": "ResourceServerScopeType",
  "description": "A resource server scope.",
  "type": "object",
  "properties": {
    "ScopeName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceServerScopeNameType"
        },
        {
          "description": "The name of the scope."
        }
      ]
    },
    "ScopeDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceServerScopeDescriptionType"
        },
        {
          "description": "A description of the scope."
        }
      ]
    }
  },
  "required": [
    "ScopeName",
    "ScopeDescription"
  ]
}