Skip to main content

List Identity Attributes

GET 

/identity-attributes

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Use this API to get 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

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

List of identity attributes.

Schema

  • Array [

  • name stringrequired

    Identity attribute's technical name.

    displayName string

    Identity attribute's business-friendly name.

    standard boolean

    Indicates whether the attribute is 'standard' or 'default'.

    type stringnullable

    Identity attribute's type.

    multi boolean

    Indicates whether the identity attribute is multi-valued.

    searchable boolean

    Indicates whether the identity attribute is searchable.

    system boolean

    Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable.

    sources

    object[]

    Identity attribute's list of sources - this specifies how the rule's value is derived.

  • Array [

  • type string

    Attribute mapping type.

    properties object

    Attribute mapping properties.

  • ]

  • ]

Loading...