API Data Provider - Online Help

Roles

Returns the list of all roles configured in your organization.

Columns

Name Type ReadOnly References Description
RoleId [KEY] String True

Role unique identifier (UUID)

RoleType String False

Resource type (roles)

RoleName String False

Role name

CreatedAt Datetime True

Creation timestamp (ISO 8601)

ModifiedAt Datetime True

Modification timestamp (ISO 8601)

IsManaged Boolean True

Whether role is system managed

UserCount Integer True

Number of users with this role

TeamCount Integer True

Number of teams with this role

Relationships String True

Relationships of the role object returned by the API

Pseudocolumns

Pseudocolumn fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.

Name Type Description
FilterQuery String

Filter all roles by the given string

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770.0