Retrieve a Customer user

GET /v1/Customers/{customerId}/users/{customerUserId}

Retrieves a Customer user with the specified GUID identifier.

Headers

  • X-Tenant string Required

    This header identifies which tenant to access with this request. This value should be an existent domain for the specified tenant.

  • 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.

  • customerUserId string(uuid) Required

    GUID Unique identifier for the customer user.

Query parameters

Responses

  • • 200

    Success

    Hide response attributes Show response 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.

    • Additional properties are NOT allowed
    Hide response attributes Show response 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.

    • Additional properties are NOT allowed
    Hide response attributes Show response 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.

    • Additional properties are NOT allowed
  • • 400

    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
  • • 401

    Unauthorized

  • • 403

    Forbidden

  • • 404

    Not Found

    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
  • • 500

    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
    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

      This class is used to represent the details of an error and specifies the name of the property and the description of each of the errors associated with that property.

      Hide errors attributes Show errors attributes object
    • Additional properties are NOT allowed
GET /v1/Customers/{customerId}/users/{customerUserId} 
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/users/{customerUserId}?providerInstanceId=string \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200) 
{
  "id": "string",
  "displayName": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "location": "string",
  "temporaryPassword": "string",
  "domain": "string"
}
Response examples (200) 
{
  "id": "string",
  "displayName": "string",
  "email": "string",
  "firstName": "string",
  "lastName": "string",
  "location": "string",
  "temporaryPassword": "string",
  "domain": "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 (404) 
{
  "statusCode": 42,
  "type": "string",
  "description": "string",
  "correlationId": "string",
  "errors": [
    {
      "propertyName": "string",
      "description": [
        "string"
      ]
    }
  ]
}
Response examples (404) 
{
  "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"
      ]
    }
  ]
}