Skip to main content

Get a list of public identities

GET 

/public-identities

Get a list of public identities

Request

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

    Default value: 0

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

    Example: 0
    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, in

    alias: eq, sw

    email: eq, sw

    firstname: eq, sw

    lastname: eq, sw

    Example: firstname eq "John"
    add-core-filters boolean

    If true, only get identities which satisfy ALL the following criteria in addition to any criteria specified by filters:

    • Should be either correlated or protected.
    • Should not be "spadmin" or "cloudadmin".
    • uid should not be null.
    • lastname should not be null.
    • email should not be null.
    Example: false
    sorters comma-separated

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

    Sorting is supported for the following fields: name

    Example: name

Responses

A list of public identity objects.

Schema

  • Array [

  • id string

    Identity id

    name string

    Human-readable display name of identity.

    alias string

    Alternate unique identifier for the identity.

    email stringnullable

    Email address of identity.

    status stringnullable

    The lifecycle status for the identity

    identityState stringnullable

    Possible values: [ACTIVE, INACTIVE_SHORT_TERM, INACTIVE_LONG_TERM, null]

    The current state of the identity, which determines how Identity Security Cloud interacts with the identity. An identity that is Active will be included identity picklists in Request Center, identity processing, and more. Identities that are Inactive will be excluded from these features.

    manager

    object

    nullable

    An identity reference to the manager of this identity

    type DtoType (string)

    Possible values: [ACCOUNT_CORRELATION_CONFIG, ACCESS_PROFILE, ACCESS_REQUEST_APPROVAL, ACCOUNT, APPLICATION, CAMPAIGN, CAMPAIGN_FILTER, CERTIFICATION, CLUSTER, CONNECTOR_SCHEMA, ENTITLEMENT, GOVERNANCE_GROUP, IDENTITY, IDENTITY_PROFILE, IDENTITY_REQUEST, LIFECYCLE_STATE, PASSWORD_POLICY, ROLE, RULE, SOD_POLICY, SOURCE, TAG, TAG_CATEGORY, TASK_RESULT, REPORT_RESULT, SOD_VIOLATION, ACCOUNT_ACTIVITY, WORKGROUP]

    An enumeration of the types of DTOs supported within the IdentityNow infrastructure.

    id string

    Identity id

    name string

    Human-readable display name of identity.

    attributes

    object[]

    The public identity attributes of the identity

  • Array [

  • key string

    The attribute key

    name string

    Human-readable display name of the attribute

    value string

    The attribute value

  • ]

  • ]

Loading...