Skip to main content

List Non-Employee Sources

GET 

/non-employee-sources

This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter:

  1. The user has the role context of idn:nesr:read, in which case he or she may request a list sources assigned to a particular account manager by passing in that manager's id.
  2. The current user is an account manager, in which case "me" should be provided as the requested-for value. This will provide the user with a list of the sources that he or she owns.

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
    requested-for stringrequired

    The identity for whom the request was made. me indicates the current user.

    Example: me
    non-employee-count boolean

    The flag to determine whether return a non-employee count associate with source.

    Example: true
    sorters comma-separated

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

    Sorting is supported for the following fields: name, created, sourceId

    Example: name,created

Responses

List of non-employee sources objects.

Schema

  • Array [

  • id UUID

    Non-Employee source id.

    sourceId string

    Source Id associated with this non-employee source.

    name string

    Source name associated with this non-employee source.

    description string

    Source description associated with this non-employee source.

    approvers

    object[]

    List of approvers

  • Array [

  • type NonEmployeeIdentityDtoType (string)

    Possible values: [GOVERNANCE_GROUP, IDENTITY]

    Identifies if the identity is a normal identity or a governance group

    id string

    Identity id

  • ]

  • accountManagers

    object[]

    List of account managers

  • Array [

  • type NonEmployeeIdentityDtoType (string)

    Possible values: [GOVERNANCE_GROUP, IDENTITY]

    Identifies if the identity is a normal identity or a governance group

    id string

    Identity id

  • ]

  • modified date-time

    When the request was last modified.

    created date-time

    When the request was created.

    nonEmployeeCount int32nullable

    Number of non-employee records associated with this source.

  • ]

Loading...