CloudCockpit API documentation

List all Groups

GET /v1/users/groups

Returns a list of groups. The groups are returned sorted by Name.

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.

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 range between 1 and 2000, and the default is 25.

Responses

• 200

text/plain

text/plain application/json text/json

Success
Hide response attributes Show response attributes object
- items array[object] | null
  
  View model that represents a group.
  
  Hide items attributes Show items attributes object
  
  id string(uuid) Required
  
  The id of the group.
  
  name string | null
  
  The group name
  
  Additional properties are NOT allowed
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Hide paginationParameters attributes Show paginationParameters attributes
  
  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.
  
  Additional properties are NOT allowed
- 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.
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- items array[object] | null
  
  View model that represents a group.
  
  Hide items attributes Show items attributes object
  
  id string(uuid) Required
  
  The id of the group.
  
  name string | null
  
  The group name
  
  Additional properties are NOT allowed
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Hide paginationParameters attributes Show paginationParameters attributes
  
  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.
  
  Additional properties are NOT allowed
- 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.
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- items array[object] | null
  
  View model that represents a group.
  
  Hide items attributes Show items attributes object
  
  id string(uuid) Required
  
  The id of the group.
  
  name string | null
  
  The group name
  
  Additional properties are NOT allowed
- paginationParameters object
  
  A model that is used to encapsulate the parameters needed to perform pagination queries.
  
  Hide paginationParameters attributes Show paginationParameters attributes
  
  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.
  
  Additional properties are NOT allowed
- 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.
- Additional properties are NOT allowed
• 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
  
  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.
  
  Additional properties are NOT allowed
- 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
  
  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.
  
  Additional properties are NOT allowed
- 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
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
• 401

Unauthorized
• 403

Forbidden
• 500

text/plain

text/plain application/json text/json

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
  
  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.
  
  Additional properties are NOT allowed
- 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
  
  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.
  
  Additional properties are NOT allowed
- 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
  
  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.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed

GET /v1/users/groups

curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/users/groups \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "name": "string"
    }
  ],
  "paginationParameters": {
    "pageNumber": 42,
    "pageSize": 42
  },
  "totalPages": 42,
  "totalCount": 42,
  "hasPreviousPage": true,
  "hasNextPage": true,
  "continuationToken": "string"
}

Response examples (200)

{
  "items": [
    {
      "id": "string",
      "name": "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"
      ]
    }
  ]
}