Skip to main content

List visible roles

GET 

/role

Lists the visible roles.

Request

Query Parameters

    pageSize string

    Possible values: >= 1

    Default value: 10

    The number of items displayed per page.

    pageNumber string

    Possible values: >= 1

    Default value: 1

    The sequence number of the current page.

    name string

    The name of the role.

    Example: ACCOUNTADMIN
    roleIdList string

    The name of the role.

    Example: role-100001,role-100002

Header Parameters

    x-maxone-role-id string

Responses

OK

Schema

    code int32

    The response code.

    data

    object

    The paginated list of roles.

    pageNumber int64

    The sequence number of current page.

    pageSize int64

    The number of items returned per page.

    records

    object[]

    The records in the current page.

  • Array [

  • createTimestamp int64

    The creation timestamp of the role.

    description string

    The description of the role.

    id stringrequired

    The ID of the role.

    isSystem boolean

    Whether the role is a system role.

    name string

    The name of the role.

    privilegeList

    object[]

    The privileges of the role.

  • Array [

  • description string

    The description of the privilege.

    id string

    The ID of the privilege.

    name string

    The name of the privilege.

    sortValue int32

    The sort order.

  • ]

  • ]

  • total int64

    The number of pages in total.

    msg string

    The response message.

Loading...