Permissions

Endpoints to manage Permissions

Permission

Details about the permission, including its ID, and name.

Properties

Name	Type	Description	Restrictions
id	string	The unique identifier of the permission	read-only, required
name	string	Name of the permission	required

Example

{
  "id": "ae82b647-8e43-44c3-a4e7-2aa3294c87ac",
  "name": "Editor"
}

PermissionsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of Permission objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[Permission]	Details about the permission, including its ID, and name.	required

Example

{
  "data": [
    {
      "id": "ae82b647-8e43-44c3-a4e7-2aa3294c87ac",
      "name": "Editor"
    },
    {
      "id": "aca32ae8-8e43-44c3-a4e7-2b64794c87ac",
      "name": "Viewer"
    },
    {
      "id": "ds90647-8e43-44c3-a4e7-2aa3294c87ac",
      "name": "Owner"
    },
    {
      "id": "sd32b647-8e43-44c3-a4e7-2aa3294c87ac",
      "name": "None"
    }
  ]
}

ResourcePermission

Mapping of the permission applied to a resource and the details of the principal to which the permission is assigned.

Properties

Name	Type	Description	Restrictions
permission	string	The unique identifier of the permission	required
principal	string	The unique identifier of the principal	required
principalType	string	The type of the principal. Refer to the principalType field to see possible types.	read-only
resource	string	The unique identifier of the resource	read-only

Enumerated Values

Property	Value
principalType	user
principalType	group

Example

{
  "permission": "ae82b647-8e43-44c3-a4e7-2aa3294c87ac",
  "principal": "V0ZVc2VyHzU2NDg2NjU2MjQ0NDQ5Mjg",
  "principalType": "user",
  "resource": "ae82b647-8e43-44c3-a4e7-2aa3294c87ac"
}

ResourcePermissionsListResult

Returns a JSON object with data and @nextLink properties. data contains a list of ResourcePermission objects, and @nextLink provides the URL to the next set of results. If there are no additional results, @nextLink doesn’t appear. If the request returns no results at all, data contains an empty array.

Properties

Name	Type	Description	Restrictions
@nextLink	string	Pagination link for next set of results
data	[ResourcePermission]	Mapping of the permission applied to a resource and the details of the principal to which the permission is assigned.	required

Example

{
  "@nextLink": "<opaque_url>",
  "data": [
    {
      "permission": "85aa87ee-beb9-4417-8fa0-420e9de63534",
      "principal": "V0ZVc2VyHzU2NDg2NjU2MjQ0NDQ5Mjg",
      "principalType": "user",
      "resource": "014b90fd-0631-422c-b94e-1240c53f1d6d"
    },
    {
      "permission": "85aa87ee-beb9-4417-8fa0-420e9de63534",
      "principal": "V0ZVc2VyHzUQ0NDQ5Mjg2NDg2NjU2Mj",
      "principalType": "group",
      "resource": "014b90fd-b94e-0631-422c-1240c53f1d6d"
    }
  ]
}

ResourcePermissionsModification

Details about the permissions modification

Properties

Name	Type	Description	Restrictions
toAssign	[ResourcePermission]¦null	The list of permissions to be assigned to the resource
toRevoke	[ResourcePermission]¦null	The list of permissions to be revoked from the resource

Example

{
  "toAssign": [
    {
      "permission": "598e8fa3-3e7c-4fb7-b662-f44522216e2b",
      "principal": "V0ZVc2VyHzU2NDg2NjU2MjQ0NDQ5Mjg"
    }
  ],
  "toRevoke": [
    {
      "permission": "85aa87ee-beb9-4417-8fa0-420e9de63534",
      "principal": "V0ZVc2VyHzU2NDg2NjU2MjQ0NDQ5Mjg"
    }
  ]
}