Resets a customer user password

PATCH /v1/Customers/{customerId}/users/{customerUserId}/reset-password

Resets the specified customer user password. 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.

  • customerUserId string(uuid) Required

    GUID Unique identifier for the customer user.

application/json

Body

The request body with the info to perform the reset. This body contains an JSON Object with two properties (providerInstanceId, customerUser).

  • providerInstanceId string(uuid) Required

    The GUID identifier for the provider instance.

  • customerUser object Required

    Additional properties are NOT allowed.

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

Responses

  • 200

    OK

  • 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

      A list containing the detail of the errors that occurred in this error scenario.

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

  • 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

      A list containing the detail of the errors that occurred in this error scenario.

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

    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.

      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
      • 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.
PATCH /v1/Customers/{customerId}/users/{customerUserId}/reset-password 
curl \
 --request PATCH 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/users/{customerUserId}/reset-password' \
 --header "Content-Type: application/json" \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string" \
 --data '{"providerInstanceId":"string","customerUser":{"id":"string","displayName":"string","email":"string","firstName":"string","lastName":"string","location":"string","temporaryPassword":"string","domain":"string"}}'
Request examples 
# Headers
X-Tenant: portal.cloudcockpit.com
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "providerInstanceId": "string",
  "customerUser": {
    "id": "string",
    "displayName": "string",
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "location": "string",
    "temporaryPassword": "string",
    "domain": "string"
  }
}