wxc_sdk.roles package

class wxc_sdk.roles.RolesApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Roles

A persona for an authenticated user, corresponding to a set of privileges within an organization. This roles resource can be accessed only by an admin and shows only roles relevant to an admin.

list() → list[IdAndName][source]

List Roles

List all roles.

Return type:: list[Role]

details(role_id: str) → IdAndName[source]

Get Role Details

Shows details for a role, by ID.

Specify the role ID in the roleId parameter in the URI.

Parameters:: role_id (str) – The unique identifier for the role.
Return type:: Role

base = 'roles'