API - Account Roles

Account Roles

Those endpoints allow you to manage the roles of a specific accounts.

Endpoints

get/api/v3/iam/account_roles

Return a paginated list of iam/account/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
id?: unknown
name?: unknown
account_id?: unknown
scopes?: unknown
info?: unknown
created_at?: unknown
updated_at?: unknown
expires_at?: unknown
not_before?: unknown
name__in?: unknown
account_id?: unknown
with_scopes?: unknown
with_projects?: unknown
The related resources to include in the response. Allowed resources are:
- `account`
- `account.person`
included?:
array
Elements: string
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?: {
    id?: any;
    name?: any;
    account_id?: any;
    scopes?: any;
    info?: any;
    created_at?: any;
    updated_at?: any;
    expires_at?: any;
    not_before?: any;
    name__in?: any;
    account_id?: any;
    with_scopes?: any;
    with_projects?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `account`
  // - `account.person`
  included?: Array<string>;
  // 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
id?: integer
name?: string
scopes?: open struct
info?: string or null
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
not_before?: null or datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      scopes?: Record<string, any>;
      info?: string | null;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      not_before?: null | Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/iam/account_roles

Create a new iam/account/roles

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
name?: string
scopes?: open struct
info?: string or null
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
not_before?: null or datetime
relationships?:
object
account:
object
data:
object
type: string
id?: string

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      scopes?: Record<string, any>;
      info?: string | null;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      not_before?: null | Date;
    };
    relationships?: { account: { data: { type: string; id?: string } } };
  };
};

delete/api/v3/iam/account_roles/:resource_id

Delete the iam/account/roles

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/iam/account_roles/:resource_id

Show a specific iam/account/roles

Input Schema

object
resource_id: integer
included?:
array
Elements: string
fields?:
dictionary
Values: array

Typescript

type InputSchema = {
  resource_id: number;
  included?: Array<string>;
  fields?: { [key: string]: Array<any> };
};

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
name?: string
scopes?: open struct
info?: string or null
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
not_before?: null or datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      scopes?: Record<string, any>;
      info?: string | null;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      not_before?: null | Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/iam/account_roles/:resource_id

Update a iam/account/roles

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
name?: string
scopes?: open struct
info?: string or null
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
not_before?: null or datetime

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      scopes?: Record<string, any>;
      info?: string | null;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      not_before?: null | Date;
    };
  };
};