Roles

Get user's current permissions

Given

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

userId

required

string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Unique user identifier.

Responses

200

Success

get/users/{userId}/permissions

Get user roles

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

userId

required

string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Unique user identifier.

query Parameters

limit	integer [ 1 .. 100 ] Default: 25 The maximum count of results to retrieve.
startingAfter	string Return results starting after the provided object identifier.
endingBefore	string Return results ending before the provided object identifier.

Responses

200

Success

get/users/{userId}/roles

Response samples

application/json

{"status": 0,
"count": 0,
"data": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"alias": "string",
"companyId": "string",
"permissions": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"action": "string",
"companyId": "string"
}
]
}
]
}

Add role to user

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

roleId required	string Unique role identifier.
userId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... Unique user identifier.

Responses

204

Success no content

put/users/{userId}/roles/{roleId}

Remove role from user

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

roleId required	string Unique role identifier.
userId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... Unique user identifier.

Responses

204

Success no content

delete/users/{userId}/roles/{roleId}

➔ Next to Investors

Request sandbox access