Api Keys

No description given.

Endpoints

get /api/v3/iam/api_keys post /api/v3/iam/api_keys delete /api/v3/iam/api_keys/:resource_id get /api/v3/iam/api_keys/:resource_id patch /api/v3/iam/api_keys/:resource_id get /api/v3/iam/api_keys/permissions

get/api/v3/iam/api_keys

Return a paginated list of iam/account/api_keys

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
account_id?: unknown
name?: unknown
key_label?: unknown
key_sha?: unknown
key?: unknown
last_used_at?: unknown
permissions?: unknown
from_role?: unknown
created_at?: 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?: {
    id?: any;
    account_id?: any;
    name?: any;
    key_label?: any;
    key_sha?: any;
    key?: any;
    last_used_at?: any;
    permissions?: any;
    from_role?: any;
    created_at?: 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
id?: integer
name?: string
key_label?: string
key?: string
last_used_at?: datetime
permissions?: array
from_role?: string
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      key_label?: string;
      key?: string;
      last_used_at?: Date;
      permissions?: Array<any>;
      from_role?: string;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/iam/api_keys

Create a new iam/account/api_keys

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
name?: string
key_label?: string
key?: string
last_used_at?: datetime
permissions?: array
from_role?: string
created_at?: datetime

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      key_label?: string;
      key?: string;
      last_used_at?: Date;
      permissions?: Array<any>;
      from_role?: string;
      created_at?: Date;
    };
  };
};

delete/api/v3/iam/api_keys/:resource_id

Delete the iam/account/api_keys

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/iam/api_keys/:resource_id

Show a specific iam/account/api_keys

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
key_label?: string
key?: string
last_used_at?: datetime
permissions?: array
from_role?: string
created_at?: datetime
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      name?: string;
      key_label?: string;
      key?: string;
      last_used_at?: Date;
      permissions?: Array<any>;
      from_role?: string;
      created_at?: Date;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/iam/api_keys/:resource_id

Update a iam/account/api_keys

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
name?: string
key?: string
last_used_at?: datetime
created_at?: datetime

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      name?: string;
      key?: string;
      last_used_at?: Date;
      created_at?: Date;
    };
  };
};

get/api/v3/iam/api_keys/permissions

List all existing permissions used when generating an API key. Based on the role used to generate the key, some permissions may be unavailable.