Get All User Identities
You can get a resource representation of user identities in Veeam Service Provider Console.
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 all user identities, send the GET HTTP request to the URL of the /users/logins collection.
HTTP Request
GET https://<hostname>:1280/api/v3/users/logins |
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 |
|---|---|---|---|---|---|
limit | Query | Integer (int32) | No | 100 | Specifies the first N resources that must be returned in the output |
offset | Query | Integer (int32) | No | 0 | Excludes the first N resources from the query output |
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 collection resource representation based on the UserLogin schema.
Example 
The following request returns a representation of all user identities.
Request: GET https://localhost:1280/api/v3/users/logins
Request Header: Authorization: Bearer <Access-Token>
Response Code: 200 OK
Response Body: { "meta": { "pagingInfo": { "total": 3, "count": 3, "offset": 0 } }, "data": [ { "id": 1, "userId": "c28df41e-5182-4668-b911-1987d4c9150f", "userName": "Alpha", "companyId": "63217eab-3aac-4bd8-87c3-f338010758f5", "companyName": "Alpha", "identityProviderName": "VBR", "description": null, "identifierInProvider": "Alpha", "scopes": [ "integration", "rest", "ui" ], "status": "enabled", "parameters": "", "creationDate": "2020-03-04T00:47:16.5789853+00:00" }, { "id": 2, "userId": "0a630b4a-081d-48ad-8ad1-bd14cfecc447", "userName": "vspc\\Administrator", "companyId": "df48c40c-e931-4ff8-8b2a-40a00d01c44d", "companyName": "Beta", "identityProviderName": "WIN", "description": null, "identifierInProvider": "vspc\\Administrator", "scopes": [ "integration", "rest", "ui" ], "status": "enabled", "parameters": "", "creationDate": "2020-03-04T01:18:31.6138903+00:00" }, { "id": 3, "userId": "d02f1c7f-a6dc-492f-82d7-0c6f072b2385", "userName": "Stan Smith", "companyId": "91c20e53-8c34-4eef-ab1e-95d6eb5ded5a", "companyName": "Omega", "identityProviderName": "VSPC", "description": null, "identifierInProvider": "Omega", "scopes": [ "integration", "rest", "ui" ], "status": "enabled", "parameters": "", "creationDate": "2020-03-04T01:29:56.3652364+00:00" } ] } |
