---
title: "Scope"
url: "https://nov18-dev.movespot.fyi/apis/konnect-sliver-1/versions/3f8cda05-1eea-4a0c-b583-c24374bebb67/schemas/Scope"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-sliver-1/versions/3f8cda05-1eea-4a0c-b583-c24374bebb67.md

# Scope

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Sliver
  version: 1.0.0
servers:
  - url: https://us.api.konghq.com/v1
    description: United-States Production region
  - url: https://eu.api.konghq.com/v1
    description: Europe Production region
  - url: https://au.api.konghq.com/v1
    description: Australia Production region
  - url: https://me.api.konghq.com/v1
    description: Middle-East Production region
  - url: https://in.api.konghq.com/v1
    description: India Production region
  - url: https://sg.api.konghq.com/v1
    description: Singapore Production region
components:
  schemas:
    ScopeName:
      description: The name of the scope
      type: string
      minLength: 1
    ScopeDescription:
      description: Description of the scope
      type: string
    ScopeDefault:
      description: Specifies whether the scope is included by default in access tokens
        without being explicitly requested by the client. If the scope is not
        allowed by the client, it will not be included in the access token.
      type: boolean
      default: false
    ScopeIncludeInMetadata:
      description: Specifies whether to include the scope in the metadata document
      type: boolean
      default: false
    ScopeEnabled:
      description: Specifies whether the scope is enabled. If the scope is not
        enabled, it cannot be requested by clients and will not be included in
        the access token.
      type: boolean
      default: true
    CreatedAt:
      description: An ISO-8601 timestamp representation of entity creation date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    UpdatedAt:
      description: An ISO-8601 timestamp representation of entity update date.
      type: string
      format: date-time
      example: 2022-11-04T20:10:06.927Z
      readOnly: true
    Scope:
      type: object
      properties:
        id:
          description: The ID of the scope
          type: string
          format: uuid
        name:
          $ref: "#/components/schemas/ScopeName"
        description:
          $ref: "#/components/schemas/ScopeDescription"
        default:
          $ref: "#/components/schemas/ScopeDefault"
        include_in_metadata:
          $ref: "#/components/schemas/ScopeIncludeInMetadata"
        enabled:
          $ref: "#/components/schemas/ScopeEnabled"
        created_at:
          $ref: "#/components/schemas/CreatedAt"
        updated_at:
          $ref: "#/components/schemas/UpdatedAt"
      required:
        - id
        - name
        - description
        - default
        - include_in_metadata
        - enabled
        - created_at
        - updated_at
```
