Community Tenant Collection Acls

Save PDF

Last UpdatedJan 20, 2023
3 minute read

APIs for managing community tenant collection access control lists.

`Get Community Tenant Collection Access Control List`

Gets the community tenant collection access control list.

Request

GET /api/v1-preview/tenants/{tenantId}/accesscontrol/communities

Parameters

string tenantId
Owning tenant identifier.

Response

Status Code	Body Type	Description
200	None	The AccessControlList of a Community resource.
400	ErrorResponse	Bad Request. The server could not understand the request.
401	ErrorResponse	Unauthorized. The client has not been authenticated.
403	ErrorResponse	Forbidden. The client does not have the required permissions to make the request.
404	ErrorResponse	Not Found. The requested community tenant was not found.
500	ErrorResponse	Internal Server Error. The server has encountered a situation it doesn't know how to handle.

`Update Community Tenant Collection Access Control List`

Updates the community tenant collection access control list for a specified tenant.

Request

PUT /api/v1-preview/tenants/{tenantId}/accesscontrol/communities

Parameters

string tenantId
Owning tenant identifier.

Request Body

The new access control list to update the current entry with.

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

Response

Status Code	Body Type	Description
204	None	Success.
400	ErrorResponse	Bad Request. The server could not understand the request.
401	ErrorResponse	Unauthorized. The client has not been authenticated.
403	ErrorResponse	Forbidden. The client does not have the required permissions to make the request.
404	ErrorResponse	Not Found. The requested community tenant was not found.
500	ErrorResponse	Internal Server Error. The server has encountered a situation it doesn't know how to handle.

`Get Community Tenant Access Rights`

Get the effective access rights for the community tenant collection.

Request

GET /api/v1-preview/tenants/{tenantId}/accessrights/communities

Parameters

string tenantId
The requested tenant identifier.

Response

Status Code	Body Type	Description
200	None	An enumerable of all allowed Access Rights for a CommunityTenant resource.
400	ErrorResponse	Bad Request. The server could not understand the request.
401	ErrorResponse	Unauthorized. The client has not been authenticated.
403	ErrorResponse	Forbidden. The client does not have the required permissions to make the request.
404	ErrorResponse	Not Found. The requested community tenant was not found.
500	ErrorResponse	Internal Server Error. The server has encountered a situation it doesn't know how to handle.

Authorization

Allowed for these roles:

Tenant Member

Definitions

ErrorResponse

Object returned whenever there is an error

Properties

Property Name	Data Type	Required	Nullable	Description
OperationId	string	true	false	Operation identifier of action that caused the error
Error	string	true	false	Error description
Reason	string	true	false	Reason for the error
Resolution	string	true	false	Resolution to resolve the error
DynamicProperties	object	false	true	Additional properties

{
  "OperationId": "string",
  "Error": "string",
  "Reason": "string",
  "Resolution": "string",
  "DynamicProperties": {
    "property1": null,
    "property2": null
  },
  "property1": null,
  "property2": null
}

AccessControlList

Properties

Property Name	Data Type	Required	Nullable	Description
RoleTrusteeAccessControlEntries	[AccessControlEntry]	false	true	None

{
  "RoleTrusteeAccessControlEntries": [
    {
      "Trustee": {
        "Type": 1,
        "ObjectId": "string",
        "TenantId": "string"
      },
      "AccessType": 0,
      "AccessRights": 0
    }
  ]
}

AccessControlEntry

Properties

Property Name	Data Type	Required	Nullable	Description
Trustee	Trustee	false	true	None
AccessType	AccessType	false	false	None
AccessRights	int64	false	false	None

{
  "Trustee": {
    "Type": 1,
    "ObjectId": "string",
    "TenantId": "string"
  },
  "AccessType": 0,
  "AccessRights": 0
}

Trustee

Properties

Property Name	Data Type	Required	Nullable	Description
Type	TrusteeType	false	false	None
ObjectId	string	false	true	None
TenantId	string	false	true	None

{
  "Type": 1,
  "ObjectId": "string",
  "TenantId": "string"
}

TrusteeType

Enumerated Values

Property	Value
User	1
Client	2
Role	3

AccessType

Enumerated Values

Property	Value
Allowed	0
Denied	1

CONNECT data services developer documentation