Function getRoles

  • Returns a list of roles using cursor-based pagination.

    Parameters

    • query: {
          filter?: string;
          limit?: number;
          next?: string;
          prev?: string;
          sort?: string;
          totalResults?: boolean;
      }

      an object with query parameters

      • Optionalfilter?: string

        The advanced filtering to use for the query. Refer to RFC 7644 for the syntax. All conditional statements within this query parameter are case insensitive.

      • Optionallimit?: number

        The number of roles to retrieve.

      • Optionalnext?: string

        The next page cursor.

      • Optionalprev?: string

        The previous page cursor.

      • Optionalsort?: string

        Optional resource field name to sort on, eg. name. Can be prefixed with +/- to determine order, defaults to (+) ascending.

      • OptionaltotalResults?: boolean

        Determines wether to return a count of the total records matched in the query. Defaults to false.

    • Optionaloptions: ApiCallOptions

    Returns Promise<GetRolesHttpResponse>

    GetRolesHttpError