PlatformRoleGetAllOptions

PlatformRoleGetAllOptions = PaginationOptions & { contains?: string; roleType?: PlatformRoleType; scopeType?: PlatformRoleScopeType; serviceName?: string; sortBy?: PlatformRoleSortField; sortOrder?: PlatformRoleSortOrder; 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 roles of this type.

scopeType?

optional scopeType: PlatformRoleScopeType

Returns only roles applying at this level.

serviceName?

optional serviceName: string

Returns only roles owned by this service.

sortBy?

optional sortBy: PlatformRoleSortField

Field to sort by.

sortOrder?

optional sortOrder: PlatformRoleSortOrder

Sort direction.

tenantId?

optional tenantId: string

Returns only roles of this tenant.