Create a delegated admin relationship

POST /v1/Customers/{customerId}/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

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. 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 four properties (providerInstanceId, displayName, AutoExtendEnabled and CustomSelectedGdapRolesIds).

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.
customSelectedGdapRolesIds array[string] | null

A list of ids of the custom GDAP roles selection. In the absence of this property (null), a new relationship with the default roles set in the portal will be created. The ids of the possible roles to chose from can be found here https://learn.microsoft.com/en-us/entra/identity/role-based-access-control/permissions-reference#all-roles

Responses

200

text/plain

text/plain application/json text/json

OK
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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
- 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
  
  Additional properties are NOT allowed.
  
  Hide accessDetails attribute Show accessDetails attribute object
  
  unifiedRoles array[object] | null
  
  The directory roles that the Microsoft partner is assigned in the customer tenant.
  
  Hide unifiedRoles attribute Show unifiedRoles attribute object
  
  roleDefinitionId string | null
  
  The unified role definition ID of the directory role.
- autoExtendDuration string | null
  
  The auto extend duration of the relationship
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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
- 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
  
  Additional properties are NOT allowed.
  
  Hide accessDetails attribute Show accessDetails attribute object
  
  unifiedRoles array[object] | null
  
  The directory roles that the Microsoft partner is assigned in the customer tenant.
  
  Hide unifiedRoles attribute Show unifiedRoles attribute object
  
  roleDefinitionId string | null
  
  The unified role definition ID of the directory role.
- autoExtendDuration string | null
  
  The auto extend duration of the relationship
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
  
  Additional properties are NOT allowed.
  
  Hide status attribute Show status attribute object
  
  name string | null
  
  The name of the enumeration.
- 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
  
  Additional properties are NOT allowed.
  
  Hide accessDetails attribute Show accessDetails attribute object
  
  unifiedRoles array[object] | null
  
  The directory roles that the Microsoft partner is assigned in the customer tenant.
  
  Hide unifiedRoles attribute Show unifiedRoles attribute object
  
  roleDefinitionId string | null
  
  The unified role definition ID of the directory role.
- autoExtendDuration string | null
  
  The auto extend duration of the relationship
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
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
  
  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.
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.

POST /v1/Customers/{customerId}/delegated-admin-relationships

curl \
 -X POST https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/delegated-admin-relationships \
 -H "Content-Type: application/json" \
 -H "X-Tenant: portal.cloudcockpit.com" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string" \
 -d '{"providerInstanceId":"string","displayName":"string","autoExtendEnabled":true,"customSelectedGdapRolesIds":["729827e3-9c14-49f7-bb1b-9608f156bbb8","4d6ac14f-3453-41d0-bef9-a3e0c569773a"]}'

Request examples

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

# Payload
{
  "providerInstanceId": "string",
  "displayName": "string",
  "autoExtendEnabled": true,
  "customSelectedGdapRolesIds": [
    "729827e3-9c14-49f7-bb1b-9608f156bbb8",
    "4d6ac14f-3453-41d0-bef9-a3e0c569773a"
  ]
}

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"
      }
    ]
  },
  "autoExtendDuration": "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"
      }
    ]
  },
  "autoExtendDuration": "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"
      ]
    }
  ]
}