CloudCockpit API documentation

Create a delegated admin relationship

POST /v1/Customers/delegated-admin-relationships

Create a delegated admin relationship. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider. Available to the roles: csp, reseller

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. Optional only needed if you want to associate with a customer.

application/json

Body

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

providerInstanceId string(uuid) Required

The GUID identifier for the provider instance.
displayName string | null Required

The display name to set in the relationship. This may be up to 50 characters.
autoExtendEnabled boolean Required

The flag to indicate whether the relationship is auto extend enabled.
Additional properties are NOT allowed

Responses

• 200

text/plain

text/plain application/json text/json

Success
Hide response attributes Show response attributes object
- id string | null
  
  The id of the relationship.
- displayName string | null
  
  The display name of the relationship.
- duration string | null
  
  The duration of the relationship
- status object
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- createdDateTime string(date-time) | null
  
  The date when the relationship was created
- activatedDateTime string(date-time) | null
  
  The date when the relationship was activated
- lastModifiedDateTime string(date-time) | null
  
  The date when the relationship was last modified
- endDateTime string(date-time) | null
  
  The date when the relationship ends
- accessDetails object
  
  Hide accessDetails attributes Show accessDetails attributes
  
  unifiedRoles array[object] | null
  
  The directory roles that can be assigned to a Microsoft partner through a delegated admin relationship.
  
  Hide unifiedRoles attributes Show unifiedRoles attributes object
  
  roleDefinitionId string | null
  
  The unified role definition ID of the directory role.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- id string | null
  
  The id of the relationship.
- displayName string | null
  
  The display name of the relationship.
- duration string | null
  
  The duration of the relationship
- status object
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- createdDateTime string(date-time) | null
  
  The date when the relationship was created
- activatedDateTime string(date-time) | null
  
  The date when the relationship was activated
- lastModifiedDateTime string(date-time) | null
  
  The date when the relationship was last modified
- endDateTime string(date-time) | null
  
  The date when the relationship ends
- accessDetails object
  
  Hide accessDetails attributes Show accessDetails attributes
  
  unifiedRoles array[object] | null
  
  The directory roles that can be assigned to a Microsoft partner through a delegated admin relationship.
  
  Hide unifiedRoles attributes Show unifiedRoles attributes object
  
  roleDefinitionId string | null
  
  The unified role definition ID of the directory role.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
Hide response attributes Show response attributes object
- id string | null
  
  The id of the relationship.
- displayName string | null
  
  The display name of the relationship.
- duration string | null
  
  The duration of the relationship
- status object
  
  Hide status attributes Show status attributes
  
  name string | null
  
  The name of the enumeration.
  
  Additional properties are NOT allowed
- createdDateTime string(date-time) | null
  
  The date when the relationship was created
- activatedDateTime string(date-time) | null
  
  The date when the relationship was activated
- lastModifiedDateTime string(date-time) | null
  
  The date when the relationship was last modified
- endDateTime string(date-time) | null
  
  The date when the relationship ends
- accessDetails object
  
  Hide accessDetails attributes Show accessDetails attributes
  
  unifiedRoles array[object] | null
  
  The directory roles that can be assigned to a Microsoft partner through a delegated admin relationship.
  
  Hide unifiedRoles attributes Show unifiedRoles attributes object
  
  roleDefinitionId string | null
  
  The unified role definition ID of the directory role.
  
  Additional properties are NOT allowed
  
  Additional properties are NOT allowed
- 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
• 404

text/plain

text/plain application/json text/json

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

POST /v1/Customers/delegated-admin-relationships

curl \
 -X POST https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/delegated-admin-relationships \
 -H "Content-Type: application/json" \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string" \
 -d '{"providerInstanceId":"string","displayName":"string","autoExtendEnabled":true}'

Request example

# Headers
X-Tenant: string
Authorization: Bearer eyJ0eXAiO...
X-Correlation-Id: string

# Payload
{
  "providerInstanceId": "string",
  "displayName": "string",
  "autoExtendEnabled": true
}

Response examples (200)

{
  "id": "string",
  "displayName": "string",
  "duration": "string",
  "status": {
    "name": "string"
  },
  "createdDateTime": "2024-05-04T09:42:00+00:00",
  "activatedDateTime": "2024-05-04T09:42:00+00:00",
  "lastModifiedDateTime": "2024-05-04T09:42:00+00:00",
  "endDateTime": "2024-05-04T09:42:00+00:00",
  "accessDetails": {
    "unifiedRoles": [
      {
        "roleDefinitionId": "string"
      }
    ]
  }
}

Response examples (200)

{
  "id": "string",
  "displayName": "string",
  "duration": "string",
  "status": {
    "name": "string"
  },
  "createdDateTime": "2024-05-04T09:42:00+00:00",
  "activatedDateTime": "2024-05-04T09:42:00+00:00",
  "lastModifiedDateTime": "2024-05-04T09:42:00+00:00",
  "endDateTime": "2024-05-04T09:42:00+00:00",
  "accessDetails": {
    "unifiedRoles": [
      {
        "roleDefinitionId": "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"
      ]
    }
  ]
}