Jump to

• Request
• Response
• Examples

Get direct reportees of user based on user ID

get

/iam/governance/selfservice/api/v1/users/{uuid}/directs

Returns a list of all direct reportees of the specified user.

Request

Supported Media Types

• application/json

Path Parameters

• uuid: string
  Unique identifier of the user whose direct reportees are to be returned.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful

Headers

• ResponseTime: string
  Captures the time in milliseconds taken for processing the request.

Body ()

Root Schema : UsersDirectsListResponse

Type: object

Show Source

• count(optional): integer
• hasMore(optional): boolean
• totalResult(optional): integer
• users(optional): array users

{
    "properties":{
        "count":{
            "type":"integer"
        },
        "hasMore":{
            "type":"boolean"
        },
        "totalResult":{
            "type":"integer"
        },
        "users":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UserDirectMember"
            }
        }
    }
}

Nested Schema : users

Type: array

Show Source

• Array of: object UserDirectMember

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UserDirectMember"
    }
}

Nested Schema : UserDirectMember

Type: object

Show Source

• diplayName(optional): string
• id(optional): string
• links(optional): array links
• userlogin(optional): string

{
    "properties":{
        "id":{
            "type":"string"
        },
        "userlogin":{
            "type":"string"
        },
        "diplayName":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

Nested Schema : LinkDataInstances

Type: object

Show Source

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized

404 Response

Requested entity not found

500 Response

Internal Server Error

Back to Top

Examples

This example retrieves the direct reports for a given user.. The information shown here is against a pseudo system and serves as a prototype.

cURL Example

curl  -H "Content-Type: application/json"  -X GET  -u username:password  https://pseudo.com/iam/governance/selfservice/api/v1/users/1/directs

Example of GET Response Body

The following example shows the contents of the response body in JSON format.

{
  "links": [
    {
      "rel": "self",
      "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/1/directs"
    }
  ],
  "count": 10,
  "totalResult": -1,
  "users": [
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/13013"
        }
      ],
      "id": "13013",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest27"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/13012"
        }
      ],
      "id": "13012",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest26"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/13005"
        }
      ],
      "id": "13005",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest25"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance,/selfservice/api/v1/users/13009"
        }
      ],
      "id": "13009",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest24"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance,/selfservice/api/v1/users/13011"
        }
      ],
      "id": "13011",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest25"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/13008"
        }
      ],
      "id": "13008",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest25"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/13007"
        }
      ],
      "id": "13007",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest25"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/13006"
        }
      ],
      "id": "13006",
      "userLogin": "[e-mail]",
      "displayName": "UserAttrsTest25"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/3010"
        }
      ],
      "id": "3010",
      "name": "Ashish",
      "userLogin": "ASHISH_KUMAR1",
      "displayName": "Ashish Kumar Updated DN"
    },
    {
      "links": [
        {
          "rel": "self",
          "href": "http://pseudo.com/iam/governance/selfservice/api/v1/users/7008"
        }
      ],
      "id": "7008",
      "name": "UpdatedFN",
      "userLogin": "7008",
      "displayName": "Base User1"
    }
  ]
}

Back to Top