Data Access API
Note
Use of this API is dependent on enabling data security. See the associated Data Access Controls and Data Masking guides for details.
Endpoint Index
Action | Endpoint |
---|---|
Add User Data Access | PATCH /auth/users/{locator}/dataaccess/{tenantLocator} |
Fetch User Data Access | GET /auth/users/{locator}/dataaccess |
Fetch User Data Access for Tenant | GET /auth/users/{locator}/dataaccess/{tenantLocator} |
Delete User Data Access | DELETE /auth/users/{locator}/dataaccess/{tenantLocator} |
PATCH /auth/users/{locator}/dataaccess/{tenantLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
tenantLocator | path | uuid | required |
Request:UserDataAccessRequest
Response:UserDataAccessResponse
Security Group:users  Permission:write
GET /auth/users/{locator}/dataaccess
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
Response:UserDataAccessResponse[]
Security Group:users  Permission:read
GET /auth/users/{locator}/dataaccess/{tenantLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
tenantLocator | path | uuid | required |
Response:UserDataAccessResponse
Security Group:users  Permission:read
DELETE /auth/users/{locator}/dataaccess/{tenantLocator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
locator | path | uuid | required |
tenantLocator | path | uuid | required |
Response:void
Security Group:users  Permission:write
UserDataAccessRequest
¶requiredmaskingLevel Enum level1 | level2 | noneaccessControlFields map<string,map<string,string[]>>
UserDataAccessResponse
¶requiredtenantLocator uuiduserLocator uuidmaskingLevel Enum level1 | level2 | noneaccessControlFields map<string,map<string,string[]>>