List all Customer users

GET /v1/Customers/{customerId}/users

Returns a list of your customer users for a specified customer. The customer users are returned sorted by the specified sortPropertyName. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider.

Headers

X-Tenant string Required

The domain used to access the portal.
Authorization string Required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Default value is Bearer eyJ0eXAiO....
X-Correlation-Id string(UUID)

This header is optional and by setting it you can correlate the audit logs made by this request.

Path parameters

customerId string(uuid) Required

GUID Unique identifier for the customer.

Query parameters

providerInstanceId string(uuid) Required

GUID Unique identifier for the provider instance.
pageNumber integer(int32)

A cursor for pagination across multiple pages of results. The default value is 1.
pageSize integer(int32)

The number of objects to be returned at each page. The size can range between 1 and 2000, and the default is 25.
searchValue string

The search query string.
sortPropertyName string

The name of the property to sort the customers by. Possible values: DisplayName, UserPrincipalName
ascendingOrder boolean

if set to true [ascending order].
seekOperation string

The seek operation type. The default value is Next. Possible values: Next, Previous, First, Last and PageIndex
resellerId string(uuid)

GUID Unique identifier for the reseller. View only the customers that have relation with the specified resellerId.

Responses

200

text/plain

text/plain application/json text/json

OK
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Hide items attributes Show items attributes object
  
  id string(uuid)
  
  The GUID identifier for the customer.
  
  displayName string | null Required
  
  The customer user display name. This may be up to 50 characters.
  
  email string | null Required
  
  The customer user email. This may be up to 48 characters.
  
  firstName string | null
  
  THe customer user first name. This may be up to 50 characters.
  
  lastName string | null
  
  The customer user last name. This may be up to 50 characters.
  
  location string | null Required
  
  The customer user location.
  
  temporaryPassword string | null
  
  The customer user temporary password.
  
  domain string | null Required
  
  The customer domain.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Hide items attributes Show items attributes object
  
  id string(uuid)
  
  The GUID identifier for the customer.
  
  displayName string | null Required
  
  The customer user display name. This may be up to 50 characters.
  
  email string | null Required
  
  The customer user email. This may be up to 48 characters.
  
  firstName string | null
  
  THe customer user first name. This may be up to 50 characters.
  
  lastName string | null
  
  The customer user last name. This may be up to 50 characters.
  
  location string | null Required
  
  The customer user location.
  
  temporaryPassword string | null
  
  The customer user temporary password.
  
  domain string | null Required
  
  The customer domain.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
Hide response attributes Show response attributes object
- items array[object] | null
  
  The items for this page.
  
  Hide items attributes Show items attributes object
  
  id string(uuid)
  
  The GUID identifier for the customer.
  
  displayName string | null Required
  
  The customer user display name. This may be up to 50 characters.
  
  email string | null Required
  
  The customer user email. This may be up to 48 characters.
  
  firstName string | null
  
  THe customer user first name. This may be up to 50 characters.
  
  lastName string | null
  
  The customer user last name. This may be up to 50 characters.
  
  location string | null Required
  
  The customer user location.
  
  temporaryPassword string | null
  
  The customer user temporary password.
  
  domain string | null Required
  
  The customer domain.
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Additional properties are NOT allowed.
  
  Hide paginationParameters attributes Show paginationParameters attributes object
  
  pageNumber integer(int32)
  
  Indicates the number of the current page.
  
  pageSize integer(int32)
  
  The number of items that should be returned at most per page.
- totalPages integer(int32)
  
  The total number of pages available for the specified parameters and page size.
- totalCount integer(int32)
  
  The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
- hasPreviousPage boolean
  
  Indicates if there is a previous page.
- hasNextPage boolean
  
  Indicates if there is a next page.
- continuationToken string | null
  
  The token to continue to retrieve the paginated items.
400

text/plain

text/plain application/json text/json

Bad Request
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
401

Unauthorized
403

Forbidden
500

text/plain

text/plain application/json text/json

Internal Server Error
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.
Hide response attributes Show response attributes object
- statusCode integer(int32)
  
  The HTTP status code that represents a specific error scenario.
- type string | null
  
  The type of error that occurred.
- description string | null
  
  Describes the error scenario that occurred.
- correlationId string | null
  
  The correlationId of the request that originated the error.
- errors array[object] | null
  
  A list containing the detail of the errors that occurred in this error scenario.
  
  Hide errors attributes Show errors attributes object
  
  propertyName string | null
  
  The name of the property involved in the error.
  
  description array[string] | null
  
  A description of each error associated with the given property.

GET /v1/Customers/{customerId}/users

curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/users?providerInstanceId=string \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "displayName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "location": "string",
      "temporaryPassword": "string",
      "domain": "string"
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "displayName": "string",
      "email": "string",
      "firstName": "string",
      "lastName": "string",
      "location": "string",
      "temporaryPassword": "string",
      "domain": "string"
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (400)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}

Response examples (500)

{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}