Get information for users
To retrieve information for a user, you need the name or UUID of the user. For example, to retrieve information about a user, make a call to /UserMgmt/GetUserAttributes; note that you can specify the ID for the user or the user's name for the ID (as shown here):
/UserMgmt/GetUserAttributes
{
"ID": "auserm@gmail"
}
/UserMgmt/GetUserAttributes sample response
{
"success": true,
"Result": {
"Description": "",
"ForcePasswordChangeNext": "False",
"DisplayName": "Allen Usem",
"EmailAddress": "[email protected]",
"LoginName": "[email protected]",
"UserAttributes": {
"Description": "",
"DisplayName": "Allen Usem",
"FirstName": "Allen",
"PartnerNameList": "[\"Google\"]",
"Email": "[email protected]",
"LastName": "Userm",
"userprincipalname": "[email protected]",
"UserId": "107354040926934871406"
},
"DistinguishedName": "/C30B30B1-0B46-49AC-8D99-F6279EED7999/EF46F24B-3D37-489B-A9D7-C1ECC38A3788/076e4b41-5846-91f0-108a-9fc0ba17e02b",
"UserPrincipalName": "[email protected]",
"DirectoryServiceUuid": "C30B30B1-0B46-49AC-8D99-F6279EED7999",
"InEverybodyRole": true,
"MobileNumber": "",
"Locked": false,
"LastPasswordChangeDate": "/Date(1458323296643)/",
"OfficeNumber": "",
"FederationName": "Google",
"HomeNumber": null,
"FederationUuid": "EF46F24B-3D37-489B-A9D7-C1ECC38A3788",
"PartnerName": "Google",
"SourceDsName": "Google",
"SourceDsType": "FDS",
"CurrentState": "None",
"Uuid": "076e4b41-5846-91f0-108a-9fc0ba17e02b",
"CanonicalName": "[email protected]",
"State": "None"
},
"Message": null,
"MessageID": null,
"Exception": null,
"ErrorID": null,
"ErrorCode": null,
"InnerExceptions": null
}
You can also retrieve specific information about a user account by calling any of the following functions:
- /UserMgmt/GetUserPicture to retrieve a user's picture.
/UserMgmt/GetUserHierachy
to retrieve the management chain for a user./UserMgmt/GetUserRolesAndAdministrativeRights
to retrieve a list of roles and rights for a user.
For example, to retrieve a user's picture:
/UserMgmt/GetUserPicture
{
"ID": "[email protected]"
}
Updated about 5 years ago