Skip to main content

List Identity Attributes

GET 

/identity-attributes

This gets a collection of identity attributes.

Request

Query Parameters

    includeSystem boolean

    Include "system" attributes in the response.

    Example: false
    includeSilent boolean

    Include "silent" attributes in the response.

    Example: false
    searchableOnly boolean

    Include only "searchable" attributes in the response.

    Example: false
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true

Responses

List of identity attributes

Schema
  • Array [
  • name string

    The technical name of the identity attribute

    displayName string

    The business-friendly name of the identity attribute

    standard boolean

    Default value: false

    Shows if the attribute is 'standard' or default

    type string

    The type of the identity attribute

    multi boolean

    Default value: false

    Shows if the identity attribute is multi-valued

    searchable boolean

    Default value: false

    Shows if the identity attribute is searchable

    system boolean

    Default value: false

    Shows this is 'system' identity attribute that does not have a source and is not configurable.

    sources object[]

    List of sources for an attribute, this specifies how the value of the rule is derived

  • Array [
  • type string

    The type of the source

    properties object

    The source properties

  • ]
  • ]
Loading...