Get access assignments of a delegated admin relationship

GET /v1/Customers/delegated-admin-relationships/{relationshipId}/access-assignments
Bearer auth

Gets the list of access assignments on the given relationship. Only the access assignments associated with the configured security group are returned.

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

  • relationshipId string Required

    Id of the relationship

Query parameters

  • providerInstanceId string(uuid) Required

    Id of the provider instance where relationship is created

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • accessContainer object

      Additional properties are NOT allowed.

      Hide accessContainer attributes Show accessContainer attributes object
      • accessContainerId string | null

        The identifier of the access container (for example, a security group). For "securityGroup" access containers, this must be a valid ID of an Azure AD security group in the Microsoft partner's tenant.

      • accessContainerType object

        Additional properties are NOT allowed.

        Hide accessContainerType attribute Show accessContainerType attribute object
        • name string | null

          The name of the enumeration.

    • accessDetails object

      Additional properties are NOT allowed.

      Hide accessDetails attribute Show accessDetails attribute object
      • unifiedRoles array[object] | null
        Hide unifiedRoles attribute Show unifiedRoles attribute object
        • roleDefinitionId string | null
    • createdDateTime string(date-time) | null

      The date and time in UTC time when the access assignment was created. Read-only.

    • id string | null

      The unique identifier of the access assignment. Read-only.

    • lastModifiedDateTime string(date-time) | null

      The date and time in UTC time when this access assignment was last modified. Read-only.

    • status object

      Additional properties are NOT allowed.

      Hide status attribute Show status attribute object
      • name string | null

        The name of the enumeration.

    Hide response attributes Show response attributes object
    • accessContainer object

      Additional properties are NOT allowed.

      Hide accessContainer attributes Show accessContainer attributes object
      • accessContainerId string | null

        The identifier of the access container (for example, a security group). For "securityGroup" access containers, this must be a valid ID of an Azure AD security group in the Microsoft partner's tenant.

      • accessContainerType object

        Additional properties are NOT allowed.

        Hide accessContainerType attribute Show accessContainerType attribute object
        • name string | null

          The name of the enumeration.

    • accessDetails object

      Additional properties are NOT allowed.

      Hide accessDetails attribute Show accessDetails attribute object
      • unifiedRoles array[object] | null
        Hide unifiedRoles attribute Show unifiedRoles attribute object
        • roleDefinitionId string | null
    • createdDateTime string(date-time) | null

      The date and time in UTC time when the access assignment was created. Read-only.

    • id string | null

      The unique identifier of the access assignment. Read-only.

    • lastModifiedDateTime string(date-time) | null

      The date and time in UTC time when this access assignment was last modified. Read-only.

    • status object

      Additional properties are NOT allowed.

      Hide status attribute Show status attribute object
      • name string | null

        The name of the enumeration.

    Hide response attributes Show response attributes object
    • accessContainer object

      Additional properties are NOT allowed.

      Hide accessContainer attributes Show accessContainer attributes object
      • accessContainerId string | null

        The identifier of the access container (for example, a security group). For "securityGroup" access containers, this must be a valid ID of an Azure AD security group in the Microsoft partner's tenant.

      • accessContainerType object

        Additional properties are NOT allowed.

        Hide accessContainerType attribute Show accessContainerType attribute object
        • name string | null

          The name of the enumeration.

    • accessDetails object

      Additional properties are NOT allowed.

      Hide accessDetails attribute Show accessDetails attribute object
      • unifiedRoles array[object] | null
        Hide unifiedRoles attribute Show unifiedRoles attribute object
        • roleDefinitionId string | null
    • createdDateTime string(date-time) | null

      The date and time in UTC time when the access assignment was created. Read-only.

    • id string | null

      The unique identifier of the access assignment. Read-only.

    • lastModifiedDateTime string(date-time) | null

      The date and time in UTC time when this access assignment was last modified. Read-only.

    • status object

      Additional properties are NOT allowed.

      Hide status attribute Show status attribute object
      • name string | null

        The name of the enumeration.
  • 400

    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.

      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.

    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.

      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.

    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.

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

    Unauthorized

  • 403

    Forbidden

GET /v1/Customers/delegated-admin-relationships/{relationshipId}/access-assignments 
curl \
 --request GET 'https://api.cloudcockpit.com/v1/Customers/delegated-admin-relationships/{relationshipId}/access-assignments?providerInstanceId=string' \
 --header "X-Tenant: portal.cloudcockpit.com" \
 --header "Authorization: Bearer eyJ0eXAiO..." \
 --header "X-Correlation-Id: string"
Response examples (200) 
[
  {
    "accessContainer": {
      "accessContainerId": "string",
      "accessContainerType": {
        "name": "string"
      }
    },
    "accessDetails": {
      "unifiedRoles": [
        {
          "roleDefinitionId": "string"
        }
      ]
    },
    "createdDateTime": "2025-05-04T09:42:00Z",
    "id": "string",
    "lastModifiedDateTime": "2025-05-04T09:42:00Z",
    "status": {
      "name": "string"
    }
  }
]
Response examples (200) 
[
  {
    "accessContainer": {
      "accessContainerId": "string",
      "accessContainerType": {
        "name": "string"
      }
    },
    "accessDetails": {
      "unifiedRoles": [
        {
          "roleDefinitionId": "string"
        }
      ]
    },
    "createdDateTime": "2025-05-04T09:42:00Z",
    "id": "string",
    "lastModifiedDateTime": "2025-05-04T09:42:00Z",
    "status": {
      "name": "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"
      ]
    }
  ]
}