Roles Endpoint

This endpoint now supports the following options:

• Roles Endpoint
  • Fetch list of Roles
  • Remove Group(s) from a Role

Fetch list of Roles

GET /api/v3/roles/
Returns:
[
 {
 "shortName": "Short name for role 1",
 "longName": "",
 "__self__": "/api/v3/roles/224",
 "urn": "urn:adsk.plm:tenant.role:TENANT_NAME.224"
 },
 {
 "shortName": "Short name for role 2",
 "longName": "",
 "__self__": "/api/v3/roles/225",
 "urn": "urn:adsk.plm:tenant.role: TENANT.225"
 }
]

Remove Group(s) from a Role

This functionality allows removing one (or more) Groups from a Role using V3 API when calling the /roles/:roleId:/groups endpoint. This request will only succeed if it’s performed by an administrator.

The DELETE format is:

DELETE /api/v3/roles/{roleId}/groups
Header: Content-type: application/json
Body:
["urn:adsk.plm:tenant.group:TENANT_NAME.GROUP_ID", "urn:adsk.plm:tenant.group:TENANT_NAME.GROUP_ID",…]
Returns:
HTTP 204 (Success)

Back to top