User attributes

List user attributes

Changed on
<Note> **Organization Admin** permissions are required to use this endpoint. </Note>

Retrieve all user attribute definitions in your organization, including both custom-defined and system-defined attributes.

User attributes enable row-level security filtering, personalize dashboard content, and configure per-user database credentials. This endpoint is useful for embed integrations to discover available attributes for setting values in SSO sessions.

get/v1/user-attributes

Request

  • Base URL
    https://blobsrus.omniapp.co/api
  • URL
    https://blobsrus.omniapp.co/api/v1/user-attributes
  • Auth
    HTTP bearer

Response

List of user attribute definitions

Example response

{
  "records": [
    {
      "description": "User region for row-level security filtering",
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "label": "Region",
      "name": "region",
      "type": "String"
    }
  ]
}

Changes

    • breaking

      response property records/items/default_value list-of-types was widened by adding types array null and number to media type application/json of response 200

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the response property became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response property // became required for the status

    • info

      the response's property default value false was added for the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status