Skip to main content

List roles

GET /v1/roles

Get a paginated list of roles.

Token scope required: roles:list

Request

Query Parameters
  • includeCounts boolean

    If true, return count of total records and current page start and count in metadata

  • cursor string

    Cursor value at which to start the results, provided in nextCursor or prevCursor of a prior request

    Example: bmV4dA.eyJsb2dzLmNyZQ5iIiwiX3ZhbHVlIjo9In19
  • pageSize integer

    Possible values: <= 500

    Default value: 25

    Number of records to return in each page

Responses

Successful operation

Schema
  • data object[]
  • Array [
  • id string
  • name string
  • description string
  • firewallRules object[]
  • Array [
  • protocol string required

    Possible values: [ANY, TCP, UDP, ICMP]

  • description string

    Possible values: <= 255 characters

  • allowedRoleID string nullable

    Role ID to allow with this firewall rule. If not specified, all roles are included.

  • allowedTags key:value[]

    Tags to allow with this firewall rule. An empty list allows all tags. key is max 20 characters, value is max 50 characters, no whitespace around either allowed

  • portRange object nullable

    Range of ports for this firewall rule. If not provided or set to null, all ports are allowed.

  • from integer required

    Possible values: >= 1 and <= 65535

    First port number included in range.

  • to integer required

    Possible values: >= 1 and <= 65535

    Last port number included in range. Must be greater than from port.

  • ]
  • createdAt date-time
  • modifiedAt date-time
  • ]
  • metadata object
  • totalCount integer

    The total number of resources existing in the account

  • hasNextPage boolean

    Is there a page of data that can be fetched using the nextCursor?

  • hasPrevPage boolean

    Is there a page of data that can be fetched using the prevCursor?

  • nextCursor string

    An opaque string that can be used to fetch the next page of results. Not provided if result set is empty.

  • prevCursor string

    An opaque string that can be used to fetch the next page of results. Not provided if result set is empty.

  • page object
  • count integer required

    The number of results returned in the response.

  • start integer required

    The zero-based index of the first result within the overall list. For example, the first page will have a start of 0. If 25 results are fetched, and the nextCursor used to fetch a new page of results, the second request's start will be 25.

Loading...