Skip to main content

Identity Profiles list

This returns a list of Identity Profiles based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.

Query Parameters
  • limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
  • offset int32

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

  • 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
  • filters string

    Filter results using the standard syntax described in V3 API Standard Collection Parameters

    Filtering is supported for the following fields and operators:

    id: eq, ne

    name: eq, ne

    priority: eq, ne

  • sorters comma-separated

    Sort results using the standard syntax described in V3 API Standard Collection Parameters

    Sorting is supported for the following fields: id, name, priority

Responses

List of identityProfiles.


Schema array
  • id string

    System-generated unique ID of the Object

  • name string

    Name of the Object

  • created date-time

    Creation date of the Object

  • modified date-time

    Last modification date of the Object

  • description string

    The description of the Identity Profile.

  • owner object

    The owner of the Identity Profile.

  • type string

    Possible values: [IDENTITY]

    Type of the object to which this reference applies

  • id string

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • priority int64

    The priority for an Identity Profile.

  • authoritativeSource object

    The authoritative source for this Identity Profile.

  • type string

    Possible values: [SOURCE]

    Type of the object to which this reference applies

  • id string

    ID of the object to which this reference applies

  • name string

    Human-readable display name of the object to which this reference applies

  • identityRefreshRequired boolean

    True if a identity refresh is needed. Typically triggered when a change on the source has been made

  • identityCount int32

    The number of identities that belong to the Identity Profile.

  • identityAttributeConfig object
  • enabled boolean

    If the profile or mapping is enabled

  • attributeTransforms object[]
  • identityAttributeName string

    Name of the identity attribute

  • transformDefinition object

    The seaspray transformation definition

  • type string

    The type of the transform definition.

  • attributes object

    Arbitrary key-value pairs to store any metadata for the object

  • property name* object
  • identityExceptionReportReference object
  • taskResultId uuid

    The id of the task result

  • reportName string

    The name of the report

  • hasTimeBasedAttr boolean

    Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile.

Loading...