PlatformRoleGetAllOptions

PlatformRoleGetAllOptions = PaginationOptions & { contains?: string; roleType?: PlatformRoleType; scopeType?: string; serviceName?: string; tenantId?: string; }

Options for roles.getAll().

Type Declaration

contains?

optional contains: string

Returns only roles whose name contains the text.

roleType?

optional roleType: PlatformRoleType

Returns only built-in or only custom roles.

scopeType?

optional scopeType: string

Returns only roles applying at this scope level (e.g. ORGANIZATION, TENANT).

serviceName?

optional serviceName: string

Returns only roles owned by this service.

tenantId?

optional tenantId: string

Returns only roles of this tenant.