Data Access Controls API

Note

Use of this API is dependent on enabling data security. See the associated configuration guide for details.

Add Data Security Mask

addDataSecurityMask

PATCH /auth/users/{locator}/accessmask

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Security Group:users Permission:write

Fetch User Mask

fetchUserMask

GET /auth/users/{locator}/accessmask/{tenantLocator}/{type}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required
tenantLocator	path	uuid	required
type	path	Enum account \| policy	required

Security Group:users Permission:read

Fetch User Masks

fetchUserMasks

GET /auth/users/{locator}/accessmask

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required

Security Group:users Permission:read

Fetch User Masks for Tenant

fetchUserMasksForTenant

GET /auth/users/{locator}/accessmask/{tenantLocator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required
tenantLocator	path	uuid	required

Security Group:users Permission:read

Delete User Masks

deleteUserMasks

DELETE /auth/users/{locator}/accessmask/{tenantLocator}

Request Parameters:

Name	Position	Type	Required
locator	path	uuid	required
tenantLocator	path	uuid	required

Response:void

Security Group:users Permission:write

UserDataSecurityMaskRequest

required
tenantLocator uuid
type Enum account | policy
fields map<string,string[]>

UserDataAccessControlMaskResponse

required
tenantLocator uuid
userLocator uuid
maskType Enum account | policy
fields map<string,string[]>

See Also