Descope

Descope Custom Attributes API

The Custom Attributes API from Descope — 3 operation(s) for custom attributes.

GitHub OpenAPI

Operations 3

GET /v1/mgmt/user/customattributes Get Available Custom Attributes #
POST /v1/mgmt/user/customattribute/create Create a Custom Attributes #
POST /v1/mgmt/user/customattribute/delete Delete a Custom Attributes #

Documentation

📖
Documentation
https://docs.descope.com/api
📖
Documentation
https://docs.descope.com/auth-methods
📖
APIReference
https://docs.descope.com/api/openapi-spec
📖
Documentation
https://docs.descope.com/manage
📖
APIReference
https://docs.descope.com/api
📖
Documentation
https://docs.descope.com/inbound-apps
📖
Documentation
https://docs.descope.com/scim
📖
Documentation
https://docs.descope.com/jwks

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/descope/refs/heads/main/openapi/descope-custom-attributes-api-openapi.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/descope-custom-attributes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

descope-custom-attributes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Descope Apps Custom Attributes API
  description: Descope API
  contact:
    name: Descope
    url: https://descope.com
    email: support@descope.com
  version: 0.0.1
servers:
- url: https://api.descope.com
  description: Descope Production
- url: '{customUrl}'
  description: Custom server URL
  variables:
    customUrl:
      default: https://api.descope.com
      description: Your Descope API base URL
security:
- Descope Project ID: []
  Descope Project ID:Refresh JWT: []
  Descope Project ID:Session JWT: []
  Descope Project ID and Management Key: []
  Descope Project ID:Access Key: []
tags:
- name: Custom Attributes
paths:
  /v1/mgmt/user/customattributes:
    get:
      tags:
      - Custom Attributes
      summary: Get Available Custom Attributes
      description: '### Get available custom attributes to configure on users within a project, using a valid management key.


        This API endpoint will return the available user custom attributes within a project.


        ### See also


        - See [Custom Attributes](/manage/users#custom-user-attributes) for further details on custom user attributes

        - See [Manage Users](/manage/users) for further details on managing users.

        - See [The User Object](/api/overview#the-user-object) for further details on the user object.'
      operationId: UserCustomAttributes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAttributesResponse'
      security:
      - Descope Project ID and Management Key: []
      x-publishYaml: userManagement
      x-order: 1
      x-meta:
        title: Get Available Custom Attributes | User Management
        description: Get available custom attributes to configure on users within a project, using a valid management key.
        keywords: api, user management
  /v1/mgmt/user/customattribute/create:
    post:
      tags:
      - Custom Attributes
      summary: Create a Custom Attributes
      description: '### Create a custom attributes to configure on users within a project, using a valid management key.


        This API endpoint will create a custom attribute within a project.


        ### See also


        - See [Custom Attributes](/manage/users#custom-user-attributes) for further details on custom user attributes

        - See [Manage Users](/manage/users) for further details on managing users.

        - See [The User Object](/api/overview#the-user-object) for further details on the user object.'
      operationId: CreateUserCustomAttribute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ImportCustomAttributesRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAttributesResponse'
      security:
      - Descope Project ID and Management Key: []
      x-publishYaml: userManagement
      x-order: 2
      x-meta:
        title: Create a Custom Attributes | User Management
        description: Create a custom attributes to configure on users within a project, using a valid management key.
        keywords: api, user management
  /v1/mgmt/user/customattribute/delete:
    post:
      tags:
      - Custom Attributes
      summary: Delete a Custom Attributes
      description: '### Delete a custom attributes to configure on users within a project, using a valid management key.


        This API endpoint will delete a custom attribute within a project.


        ### See also


        - See [Custom Attributes](/manage/users#custom-user-attributes) for further details on custom user attributes

        - See [Manage Users](/manage/users) for further details on managing users.

        - See [The User Object](/api/overview#the-user-object) for further details on the user object.'
      operationId: DeleteUserCustomAttribute
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCustomAttributesRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CustomAttributesResponse'
      security:
      - Descope Project ID and Management Key: []
      x-publishYaml: userManagement
      x-order: 3
      x-meta:
        title: Delete a Custom Attributes | User Management
        description: Delete a custom attributes to configure on users within a project, using a valid management key.
        keywords: api, user management
components:
  schemas:
    CustomAttributesResponse:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttribute'
        total:
          type: string
    CustomAttribute:
      type: object
      properties:
        name:
          type: string
        type:
          type: integer
          format: int32
        options:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttributeOption'
        displayName:
          type: string
        defaultValue:
          $ref: '#/components/schemas/google.protobuf.Any'
        viewPermissions:
          type: array
          items:
            type: string
        editPermissions:
          type: array
          items:
            type: string
        editable:
          type: boolean
          description: this is to know if this specific user can edit this specific field
      description: "this object is used in project exports, make sure any changes here\n are also applied in managementservice"
    google.protobuf.Any:
      type: object
      properties:
        '@type':
          type: string
          description: The type of the serialized message.
      additionalProperties: true
      description: Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.
    DeleteCustomAttributesRequest:
      type: object
      properties:
        names:
          type: array
          items:
            type: string
    CustomAttributeOption:
      type: object
      properties:
        value:
          type: string
        label:
          type: string
      description: Custom Attributes
    ImportCustomAttributesRequest:
      type: object
      properties:
        attributes:
          type: array
          items:
            $ref: '#/components/schemas/CustomAttribute'
  securitySchemes:
    Descope_Project_ID:
      type: http
      scheme: bearer
      bearerFormat: Project ID
      description: Project ID as bearer token.
    Descope_Project_ID_Refresh_JWT:
      type: http
      scheme: bearer
      bearerFormat: Project ID:Refresh JWT
      description: Project ID:Refresh JWT as bearer token.
    Descope_Project_ID_Access_Key:
      type: http
      scheme: bearer
      bearerFormat: ProjectId:AccessKey
      description: Project ID:Access Key as bearer token.
    Descope_Project_ID_Session_JWT:
      type: http
      scheme: bearer
      bearerFormat: Project ID:Session JWT
      description: Project ID:Session JWT as bearer token.
    Descope_Project_ID_and_Management_Key:
      type: http
      description: Project ID:Management Key as bearer token.
      scheme: bearer
      bearerFormat: ProjectId:ManagementKey
externalDocs:
  description: Descope Server
  url: https://docs.descope.com