API Reference/Management/Users/Custom Attributes
POST
/v1/mgmt/user/customattribute/create

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
attributesarray<object>
curl -X POST "https://api.descope.com/v1/mgmt/user/customattribute/create" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "attributes": [
      {
        "name": "string",
        "type": 0,
        "options": [
          {
            "value": "string",
            "label": "string"
          }
        ],
        "displayName": "string",
        "defaultValue": {
          "@type": "string"
        },
        "viewPermissions": [
          "string"
        ],
        "editPermissions": [
          "string"
        ],
        "editable": true
      }
    ]
  }'

OK

{
  "data": [
    {
      "name": "string",
      "type": 0,
      "options": [
        {
          "value": "string",
          "label": "string"
        }
      ],
      "displayName": "string",
      "defaultValue": {
        "@type": "string"
      },
      "viewPermissions": [
        "string"
      ],
      "editPermissions": [
        "string"
      ],
      "editable": true
    }
  ],
  "total": "string"
}

Was this helpful?

Get Available Custom Attributes GET

### 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. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

Delete a Custom Attributes POST

### 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. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`