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.

Query parameters

• tenantId string Required

  The Microsoft tenant identifier to use in validation request to Microsoft.

• addressLine1 string Required

  The address first line.

• addressLine2 string

  The address second line.

• city string Required

  The address city.

• state string Required

  The address state.

• zipCode string Required

  The address zip code.

• country string Required

  The address country.

Responses

• 200

  text/plain

  text/plain application/json text/json

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