List all Users

GET /v1

Returns a list of your users. The users are returned sorted by the specified sortPropertyName. Available to the roles: csp, reseller

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

  • 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: Name or Email

  • ascendingOrder boolean

    if set to true [ascending order].

  • groups string

    The groups.

  • resellerId string(uuid)

    GUID Unique identifier for the reseller. View only users in the context of the specified resellerId. In case of a reseller user this property is auto-populated.

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • items array[object] | null

      The items for this page.

      View model that represents a user.

      Hide items attributes Show items attributes object
      • id string(uuid)

        The id of the user.

      • firstName string | null Required

        The first name of the user. This may be up to 255 characters.

      • lastName string | null Required

        The last name of the user. This may be up to 255 characters.

      • email string | null Required

        The email. This may be up to 255 characters.

      • role object

        Additional properties are NOT allowed.

        Hide role attribute Show role attribute object
        • name string | null

          The name of the enumeration.

      • groups array[object] | null Required

        The user groups.

        View model that represents a group.

        Hide groups attributes Show groups attributes object
        • id string(uuid) Required

          The id of the group.

        • name string | null

          The group name

    • 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

    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

  • 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.
GET /v1 
curl \
 --request GET 'https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"