List all GDAP relationships for a customer

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

Returns a list of GDAP relationships for a specific customer. Since this resource is specific to the Microsoft provider, this request is only valid for provider customers that belong to a Microsoft tenant/provider.

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.

Query parameters

Responses

GET /v1/Customers/{customerId}/delegated-admin-relationships 
curl \
 -X GET https://app-cloudcockpitapi-prod-01.azurewebsites.net/v1/Customers/{customerId}/delegated-admin-relationships?providerInstanceId=string \
 -H "X-Tenant: string" \
 -H "Authorization: Bearer eyJ0eXAiO..." \
 -H "X-Correlation-Id: string"
Response examples (200) 
[
  {
    "id": "string",
    "displayName": "string",
    "duration": "string",
    "autoExtendDuration": "string",
    "customer": {
      "tenantId": "string"
    },
    "accessDetails": {
      "unifiedRoles": [
        {
          "roleDefinitionId": "string"
        }
      ]
    }
  }
]
Response examples (200) 
[
  {
    "id": "string",
    "displayName": "string",
    "duration": "string",
    "autoExtendDuration": "string",
    "customer": {
      "tenantId": "string"
    },
    "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"
      ]
    }
  ]
}