Get User by External ID

Overview

Use this API to retrieve the details of a single user identified by external ID of a user. Only department users are retrieved with this API.

Permissions

Actor Permission
User All of the following are required:
  • If logged in user is a department user:
    • The user must have 'view permission' on the user provided in the request.
  • If logged in user is a global user, one of the following is required:
    • User must have 'Administer' permission on the departments of the user provided in the request.
    • User must have one of following privileges: 'View partition resources', 'Manage partition resources'.
Client Application No additional permission is required.
SecurityoAuthUser or oAuthClient
Request
path Parameters
id
required
string

External ID

Example: Ext208920010
query Parameters
$attribute
string

Server can be prompted to return additional attributes of resource representation using $attribute common query parameter.

Available values: all, title, middleName, suffix, created, createdBy, authenticationType, manager, emailAddress, mobileNumber, directReports, groups, languages, externalId, custom.<name>

Examples:
$attribute=
Attributes 'created' and 'manager' are returned in server response.
$attribute=created,manager
All the attributes are returned in the server response.
$attribute=all
header Parameters
Accept
required
string
Default: application/json

Content type accepted by client.

Enum: "application/json" "application/xml"
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Not Acceptable

500

Internal server error

get/user/ext-id/{id}
Request samples
Response samples
application/json
    

  • This example demonstrates the following:
      

    • Retrieving the summary attributes of a user.
      • 

    

    • 

  • GET /core/usermgr/v3/user/ext-id/ext120236
    • 



{
  • "user": [
    ]
}