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).

Responses

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"
      ]
    }
  ]
}