API - Accounts

Accounts

The accounts resource manages user accounts in the system, offering flexible filtering options and the ability to include related data such as roles, people, and organizations.

It also provides a dedicated endpoint (me) to retrieve details of the authenticated account.

Endpoints

get/api/v3/iam/accounts

Return a paginated list of iam/accounts

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
email?: unknown
account_type?: unknown
auth_type?: unknown
created_at?: unknown
updated_at?: unknown
expires_at?: unknown
password_reset_token?: unknown
password_reset_token_expires_at?: unknown
enabled?: unknown
person_id?: unknown
organization_id?: unknown
id__in?: unknown
ou_accounts?: unknown
role_name?: unknown
account_type__in?: unknown
enabled?: unknown
created_at__gte?: unknown
created_at__lte?: unknown
expires_at__gte?: unknown
expires_at__lte?: unknown
email__match?: unknown
The related resources to include in the response. Allowed resources are:
- `roles`
- `person`
- `organization`
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;
    email?: any;
    account_type?: any;
    auth_type?: any;
    created_at?: any;
    updated_at?: any;
    expires_at?: any;
    password_reset_token?: any;
    password_reset_token_expires_at?: any;
    enabled?: any;
    person_id?: any;
    organization_id?: any;
    id__in?: any;
    ou_accounts?: any;
    role_name?: any;
    account_type__in?: any;
    enabled?: any;
    created_at__gte?: any;
    created_at__lte?: any;
    expires_at__gte?: any;
    expires_at__lte?: any;
    email__match?: any;
  };
  // The related resources to include in the response. Allowed resources are:
  // - `roles`
  // - `person`
  // - `organization`
  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
email?: string
account_type?: string
auth_type?: string
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
enabled?: boolean
person_id?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: Array<{
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      email?: string;
      account_type?: string;
      auth_type?: string;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      enabled?: boolean;
      person_id?: number;
    };
    relationships?: Record<string, any>;
  }>;
  included?: Array<Record<string, any>>;
};

post/api/v3/iam/accounts

Create a new iam/accounts

Input Schema

object
data:
object
type: string
attributes:
object
id?: integer
email?: string
account_type?: string
auth_type?: string
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
enabled?: boolean
person_id?: integer
relationships?:
object
person:
object
data:
object
type: string
id?: string
attributes?: open struct

Typescript

type InputSchema = {
  data: {
    type: string;
    attributes: {
      id?: number;
      email?: string;
      account_type?: string;
      auth_type?: string;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      enabled?: boolean;
      person_id?: number;
    };
    relationships?: {
      person: {
        data: { type: string; id?: string; attributes?: Record<string, any> };
      };
    };
  };
};

delete/api/v3/iam/accounts/:resource_id

Delete the iam/accounts

Input Schema

object
resource_id: integer

Typescript

type InputSchema = { resource_id: number };

get/api/v3/iam/accounts/:resource_id

Show a specific iam/accounts

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
email?: string
account_type?: string
auth_type?: string
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
enabled?: boolean
person_id?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      email?: string;
      account_type?: string;
      auth_type?: string;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      enabled?: boolean;
      person_id?: number;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};

patch/api/v3/iam/accounts/:resource_id

Update a iam/accounts

Input Schema

object
resource_id: integer
data:
object
type: string
attributes:
object
id?: integer
email?: string
account_type?: string
auth_type?: string
expires_at?: null or datetime
enabled?: boolean
person_id?: integer

Typescript

type InputSchema = {
  resource_id: number;
  data: {
    type: string;
    attributes: {
      id?: number;
      email?: string;
      account_type?: string;
      auth_type?: string;
      expires_at?: null | Date;
      enabled?: boolean;
      person_id?: number;
    };
  };
};

get/api/v3/iam/accounts/me

Returns the personal information of the authenticated user.

Input Schema

object
included?:
array
Elements: string

Typescript

type InputSchema = { included?: Array<string> };

Output Schema

object
data:
object
type: string
id?: string
attributes?:
object
id?: integer
email?: string
account_type?: string
auth_type?: string
created_at?: datetime
updated_at?: datetime
expires_at?: null or datetime
enabled?: boolean
person_id?: integer
relationships?: open struct
included?:
array
Elements: open struct

Typescript

type OutputSchema = {
  data: {
    type: string;
    id?: string;
    attributes?: {
      id?: number;
      email?: string;
      account_type?: string;
      auth_type?: string;
      created_at?: Date;
      updated_at?: Date;
      expires_at?: null | Date;
      enabled?: boolean;
      person_id?: number;
    };
    relationships?: Record<string, any>;
  };
  included?: Array<Record<string, any>>;
};