This is an archive version of the document. To get the most up-to-date information, see the current version.Get User Identity
You can get a resource representation of a user identity with the specified ID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator, Company Owner, Company Administrator.
Request
To get a specific user identity, send the GET HTTP request to the URL of the /users/{userId}/logins/{userLoginId} resource.
HTTP Request
GET https://<hostname>:1280/api/v3/users/{userId}/logins/{userLoginId} |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Description |
|---|---|---|---|---|---|
userId | Path | String (uuid) | Yes | — | User UID |
userLoginId | Path | Integer (int64) | Yes | — | User identity ID |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Response Body
In the response body, Veeam Service Provider Console returns a resource representation based on the UserLogin schema.
Example 
The following request returns a representation of a user identity with ID 1.
Request: GET https://localhost:1280/api/v3/users/737bb56d-ce1c-4666-84b0-6c9beae50ce5/logins/1
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "data": { "id": 1, "userId": "737bb56d-ce1c-4666-84b0-6c9beae50ce5", "userName": "Alpha", "companyId": "03a99bd9-98bc-464c-ae16-c291d735de7a", "companyName": "Alpha", "identityProviderName": "VBR", "description": null, "identifierInProvider": "Alpha", "scopes": [ "integration", "rest", "ui" ], "status": "enabled", "parameters": "", "creationDate": "2020-03-04T00:47:16.5789853+00:00" } } |