Rate this page:

GetAdminRolesRequest

Props

adminRoleActive

Optional
Copy URL
adminRoleActive: 

false

|

undefined

|

true

Whether the admin role is enabled to filter

adminRoleId

Optional
Copy URL
adminRoleId: 

number

|

undefined

The admin role ID to filter

adminRoleName

Optional
Copy URL
adminRoleName: 

string

|

undefined

The admin role name part to filter

count

Optional
Copy URL
count: 

number

|

undefined

The max returning record count

excludedAdminUserId

Optional
Copy URL
excludedAdminUserId: 

any

|

number

|

number[]

Not attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users

fullAdminUsersMatching

Optional
Copy URL
fullAdminUsersMatching: 

string

|

undefined

Set false to get roles with partial admin user list matching

includedAdminUserId

Optional
Copy URL
includedAdminUserId: 

any

|

number

|

number[]

The attached admin user ID list separated by semicolons (;). Use the 'all' value to select all admin users

offset

Optional
Copy URL
offset: 

number

|

undefined

The first N records are skipped in the output

showingAdminUserId

Optional
Copy URL
showingAdminUserId: 

number

|

undefined

The admin user to show in the 'admin_users' field output

withAccountRoles

Optional
Copy URL
withAccountRoles: 

false

|

undefined

|

true

Whether to include the account roles

withEntries

Optional
Copy URL
withEntries: 

false

|

undefined

|

true

Whether to get the permissions

withParentRoles

Optional
Copy URL
withParentRoles: 

false

|

undefined

|

true

Whether to include the parent roles

withSystemRoles

Optional
Copy URL
withSystemRoles: 

false

|

undefined

|

true