API - Roles

Roles

The roles endpoint returns a list of available roles in the Pulse system.

Endpoints

get/api/v3/iam/roles

Return a paginated list of iam/roles

Input Schema

object
page?:
object
The page number, default to 1
number?: integer
The number of items per page, default to 1000
size?: integer
The sort order, comma separated list of fields. See sorting section for more details
sort?: string
Set to true to return the total number of items in the collection
count?: boolean
filter?:
object
name?: unknown
mask?: unknown
title?: unknown
rights?: unknown
description?: unknown
assignable?: unknown
scopes?: unknown
labels?: unknown
name__match?: unknown
The fields to include in the response.
The key is the resource type and the value is an array of fields.
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  page?: {
    // The page number, default to 1
    number?: number;
    // The number of items per page, default to 1000
    size?: number;
  };
  // The sort order, comma separated list of fields. See sorting section for more details
  sort?: string;
  // Set to true to return the total number of items in the collection
  count?: boolean;
  filter?: {
    name?: any;
    mask?: any;
    title?: any;
    rights?: any;
    description?: any;
    assignable?: any;
    scopes?: any;
    labels?: any;
    name__match?: any;
  };
  // The fields to include in the response.
  // The key is the resource type and the value is an array of fields.
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
array
Elements:
object
type: string
id?: string
attributes?:
object
name?: string
mask?: string
title?: string
rights?: array
description?: string
scopes?: open struct
labels?: array
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      name?: string;
      mask?: string;
      title?: string;
      rights?: Array<any>;
      description?: string;
      scopes?: Record<string, any>;
      labels?: Array<any>;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};