Get User

GET

unified

iam

users

{id}

import { StackOne } from "@stackone/stackone-client-ts";

const stackOne = new StackOne({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await stackOne.iam.getUser({
    id: "<id>",
    fields: "id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled",
    expand: "roles,groups",
    xAccountId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "primary_email_address": "han@stackone.com",
    "first_name": "Han",
    "last_name": "Solo",
    "name": "Han Solo",
    "username": "hansolo1977",
    "is_bot_user": true,
    "roles": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "<string>",
        "description": "<string>",
        "type": {
          "value": "admin",
          "source_value": "<string>"
        },
        "policies": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "name": "Remote Contractor Policy",
            "permissions": [
              {
                "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "name": "read:users",
                "type": {
                  "value": "read_write",
                  "source_value": "<string>"
                },
                "resources": [
                  {
                    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "name": "Company History Records",
                    "location": "s3://bucket-name/folder-name",
                    "type": {
                      "value": "file",
                      "source_value": "<string>"
                    },
                    "description": "<string>",
                    "created_at": "2021-01-01T01:01:01.000Z",
                    "updated_at": "2021-01-01T01:01:01.000Z"
                  }
                ],
                "description": "<string>",
                "created_at": "2021-01-01T01:01:01.000Z",
                "updated_at": "2021-01-01T01:01:01.000Z"
              }
            ],
            "description": "<string>",
            "created_at": "2021-01-01T01:01:01.000Z",
            "updated_at": "2021-01-01T01:01:01.000Z"
          }
        ],
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "groups": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "<string>",
        "description": "<string>",
        "type": {
          "value": "team",
          "source_value": "<string>"
        },
        "roles": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "name": "<string>",
            "description": "<string>",
            "type": {
              "value": "admin",
              "source_value": "<string>"
            },
            "policies": [
              {
                "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "name": "Remote Contractor Policy",
                "permissions": [
                  {
                    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "name": "read:users",
                    "type": {
                      "value": "read_write",
                      "source_value": "<string>"
                    },
                    "resources": [
                      {
                        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                        "name": "Company History Records",
                        "location": "s3://bucket-name/folder-name",
                        "type": {
                          "value": "file",
                          "source_value": "<string>"
                        },
                        "description": "<string>",
                        "created_at": "2021-01-01T01:01:01.000Z",
                        "updated_at": "2021-01-01T01:01:01.000Z"
                      }
                    ],
                    "description": "<string>",
                    "created_at": "2021-01-01T01:01:01.000Z",
                    "updated_at": "2021-01-01T01:01:01.000Z"
                  }
                ],
                "description": "<string>",
                "created_at": "2021-01-01T01:01:01.000Z",
                "updated_at": "2021-01-01T01:01:01.000Z"
              }
            ],
            "created_at": "2021-01-01T01:01:01.000Z",
            "updated_at": "2021-01-01T01:01:01.000Z"
          }
        ],
        "parent_id": "<string>",
        "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "status": {
      "value": "enabled",
      "source_value": "<string>"
    },
    "last_active_at": "2021-01-01T01:01:01.000Z",
    "last_login_at": "2021-01-01T01:01:01.000Z",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "multi_factor_enabled": [
      {
        "value": "totp",
        "source_value": "<string>"
      }
    ],
    "avatar": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "My Document",
      "path": "/path/to/file",
      "category": "templates, forms, backups, etc.",
      "contents": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "unified_custom_fields": {
            "my_project_custom_field_1": "REF-1236",
            "my_project_custom_field_2": "some other value"
          },
          "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1",
          "course_ids": [
            "16873-SOFTWARE-ENG-COURSE",
            "16874-SOFTWARE-ENG-COURSE"
          ],
          "remote_course_ids": [
            "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
            "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
          ],
          "title": "Software Engineer Lv 1",
          "description": "This video acts as learning content for software engineers.",
          "short_description": "This course is a valuable resource and acts as learning content for...",
          "languages": [
            {
              "value": "en_GB",
              "source_value": "<string>"
            }
          ],
          "content_url": "https://www.youtube.com/watch?v=16873",
          "content_type": {
            "value": "video",
            "source_value": "<string>"
          },
          "cover_url": "https://www.googledrive.com/?v=16873",
          "active": true,
          "duration": "P3Y6M4DT12H30M5S",
          "categories": [
            {
              "id": "12345",
              "name": "Technology"
            }
          ],
          "skills": [
            {
              "id": "12345",
              "name": "Sales Techniques"
            }
          ],
          "order": 1,
          "provider": "Content Provider"
        }
      ],
      "category_id": "6530",
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-02T01:01:01.000Z",
      "remote_url": "https://example.com/file.pdf",
      "file_format": {
        "value": "pdf",
        "source_value": "abc"
      }
    }
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id

string

required

The account identifier

Path Parameters

string

required

Query Parameters

raw

boolean | null

default:false

Indicates that the raw request result is returned

proxy

object | null

Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key

fields

string | null

The comma separated list of fields that will be returned in the response (if empty, all fields are returned)

expand

string | null

The comma separated list of fields that will be expanded in the response

Response

200

application/json

The user with the given identifier was retrieved.

data

object

required

data.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.primary_email_address

string | null

Primary email address of the user. This is generally a work email address.

Example:

"han@stackone.com"

data.first_name

string | null

Example:

"Han"

data.last_name

string | null

Example:

"Solo"

data.name

string | null

User's name which (can be a full name or display name)

Example:

"Han Solo"

data.username

string | null

Example:

"hansolo1977"

data.is_bot_user

Indicates if the user is a bot or service user

Example:

true

data.roles

object[] | null

List of roles the user is assigned to

data.roles.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.roles.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.roles.name

string | null

data.roles.description

string | null

data.roles.type

object

data.roles.policies

object[] | null

The set of policies associated with the role.

data.roles.created_at

string | null

Example:

"2021-01-01T01:01:01.000Z"

data.roles.updated_at

string | null

Example:

"2021-01-01T01:01:01.000Z"

data.groups

object[] | null

List of groups the user is assigned to

data.groups.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.groups.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.groups.name

string | null

data.groups.description

string | null

data.groups.type

object

data.groups.roles

object[] | null

data.groups.parent_id

string | null

The parent group id for when a group belongs to another group.

data.groups.remote_parent_id

string | null

Provider's unique identifier of the parent group id for when a group belongs to another group.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data.groups.created_at

string | null

Example:

"2021-01-01T01:01:01.000Z"

data.groups.updated_at

string | null

Example:

"2021-01-01T01:01:01.000Z"

data.status

object

data.last_active_at

string | null

The date this user was last active

Example:

"2021-01-01T01:01:01.000Z"

The date this user last logged in

Example:

"2021-01-01T01:01:01.000Z"

data.created_at

string | null

The date the user was created

Example:

"2021-01-01T01:01:01.000Z"

data.updated_at

string | null

The date the user was created

Example:

"2021-01-01T01:01:01.000Z"

data.multi_factor_enabled

object[] | null

The list of Multi-Factor Authentication (MFA) types enabled for the user.

data.avatar

object

The user's avatar data. This generally contains a URL within this property's 'contents' array.

data.avatar.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.avatar.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.avatar.name

string | null

The name of the file

Example:

"My Document"

data.avatar.path

string | null

The path where the file is stored

Example:

"/path/to/file"

data.avatar.category

object

The category of the file

Example:

"templates, forms, backups, etc."

data.avatar.contents

object[] | null

deprecated

The content of the file. Deprecated, use url and file_format one level up instead

data.avatar.contents.id

string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.avatar.contents.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.avatar.contents.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.avatar.contents.external_reference

string | null

The external ID associated with this content

Example:

"SOFTWARE-ENG-LV1-TRAINING-VIDEO-1"

data.avatar.contents.course_ids

string[] | null

The parent ID/IDs associated with this content

Example:

[
  "16873-SOFTWARE-ENG-COURSE",
  "16874-SOFTWARE-ENG-COURSE"
]

data.avatar.contents.remote_course_ids

string[] | null

Provider's unique identifier of the parent course ID associated with this content

Example:

[
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
]

data.avatar.contents.title

string | null

The title of the content

Example:

"Software Engineer Lv 1"

data.avatar.contents.description

string | null

The description of the content

Example:

"This video acts as learning content for software engineers."

data.avatar.contents.short_description

string | null

A short description or summary for the content

Example:

"This course is a valuable resource and acts as learning content for..."

data.avatar.contents.languages

object[] | null

The languages associated with this content

data.avatar.contents.languages.value

enum<string> | null

The Locale Code of the language

Available options:

ar_AR,

aa_ER,

af_NA,

af_ZA,

am_ET,

ar_AE,

ar_BH,

ar_DJ,

ar_DZ,

ar_EG,

ar_ER,

ar_IQ,

ar_JO,

ar_KM,

ar_KW,

ar_LB,

ar_LY,

ar_MA,

ar_MR,

ar_OM,

ar_PS,

ar_QA,

ar_SA,

ar_SD,

ar_SY,

ar_TD,

ar_TN,

ar_YE,

ay_BO,

ay_PE,

az_AZ,

az_IR,

be_BY,

bg_BG,

bi_VU,

bn_BD,

bn_IN,

bs_BA,

bs-ME,

byn_ER,

ca_AD,

ca_ES,

ca_FR,

ca_IT,

ch_GU,

cs_CZ,

da_DK,

de_AT,

de_BE,

de_CH,

de_DE,

de_LI,

de_LU,

de_VA,

de_MV,

dv_MV,

dz_BT,

el_CY,

el_GR,

en_AG,

en_AI,

en_AS,

en_AU,

en_BB,

en_BE,

en_BM,

en_BS,

en_BW,

en_BZ,

en_CA,

en_CC,

en_CK,

en_CM,

en_CW,

en_CX,

en_DG,

en_DM,

en_ER,

en_FJ,

en_FK,

en_FM,

en_GB,

en_GD,

en_GG,

en_GH,

en_GI,

en_GM,

en_GS,

en_GU,

en_GY,

en_HK,

en_IE,

en_IM,

en_IN,

en_IO,

en_JE,

en_JM,

en_KE,

en_KI,

en_KN,

en_KY,

en_LC,

en_LR,

en_LS,

en_MF,

en_MG,

en_MH,

en_MO,

en_MP,

en_MS,

en_MT,

en_MU,

en_MW,

en_MY,

en_NA,

en_NF,

en_NG,

en_NL,

en_NR,

en_NU,

en_NZ,

en_PG,

en_PH,

en_PK,

en_PN,

en_PR,

en_PW,

en_RW,

en_SB,

en_SC,

en_SD,

en_SG,

en_SH,

en_SL,

en_SS,

en_SX,

en_SZ,

en_TC,

en_TK,

en_TO,

en_TT,

en_TV,

en_TZ,

en_UG,

en_UM,

en_US,

en_VC,

en_VG,

en_VI,

en_VU,

en_WS,

en_ZA,

en_ZM,

en_ZW,

es_AR,

es_BO,

es_BZ,

es_CL,

es_CO,

es_CR,

es_CU,

es_DO,

es_EA,

es_EC,

es_EH,

es_ES,

es_GQ,

es_GT,

es_HN,

es_IC,

es_LA,

es_MX,

es_NI,

es_PA,

es_PE,

es_PH,

es_PR,

es_PY,

es_SV,

es_US,

es_UY,

es_VE,

et_EE,

fa_AF,

fa_IR,

fan_GA,

ff_CM,

ff_GN,

ff_MR,

ff_SN,

ff_BF,

fi_FI,

fj_FJ,

fo_FO,

fr_BE,

fr_BF,

fr_BI,

fr_BJ,

fr_BL,

fr_CA,

fr_CD,

fr_CF,

fr_CG,

fr_CH,

fr_CI,

fr_CM,

fr_DJ,

fr_DZ,

fr_FR,

fr_GA,

fr_GF,

fr_GG,

fr_GN,

fr_GP,

fr_GQ,

fr_HT,

fr_KM,

fr_JE,

fr_LU,

fr_LB,

fr_MA,

fr_MC,

fr_MF,

fr_MG,

fr_ML,

fr_MQ,

fr_MR,

fr_MU,

fr_NC,

fr_NE,

fr_PF,

fr_PM,

fr_RE,

fr_RW,

fr_SC,

fr_SN,

fr_SY,

fr_TD,

fr_TF,

fr_TG,

fr_TN,

fr_VU,

fr_VA,

fr_WF,

fr_YT,

ga_IE,

gn_PY,

gn_AR,

gu_IN,

gv_IM,

he_IL,

hi_IN,

hr_BA,

hr_HR,

hr_ME,

ht_HT,

hu_HU,

hy_AM,

hy_CY,

id_ID,

is_IS,

it_CH,

it_IT,

it_SM,

it_VA,

ja_JP,

ka_GE,

kg_CD,

kk_KZ,

kl_GL,

km_KH,

ko_KP,

ko_KR,

ku_IQ,

ky_KG,

la_VA,

lb_LU,

ln_AO,

ln_CD,

ln_CF,

ln_CG,

lo_LA,

lt_LT,

lu_CD,

lv_LV,

mg_MG,

mh_MH,

mi_NZ,

mk_MK,

mn_MN,

mr_IN,

ms_BN,

ms_MY,

ms_SG,

mt_MT,

my_MM,

nb_NO,

nb_BV,

nb_ZW,

ne_NP,

nl_AW,

nl_BE,

nl_BQ,

nl_CW,

nl_NL,

nl_SR,

nl_SX,

nl_MF,

nn_NO,

nn_BV,

no_NO,

no_BV,

no_SJ,

nr_ZA,

ny_MW,

pa_IN,

pa_PK,

pl_PL,

ps_AF,

pt_AO,

pt_BR,

pt_CH,

pt_CV,

pt_GQ,

pt_GW,

pt_LU,

pt_MO,

pt_MZ,

pt_PT,

pt_ST,

pt_TL,

qu_BO,

qu_EC,

qu_PE,

rar_CK,

rm_CH,

rup_MK,

ro_MD,

ro_RO,

ru_BY,

ru_KG,

ru_KZ,

ru_MD,

ru_RU,

ru_UA,

ru_AQ,

ru_TJ,

ru_TM,

ru_UZ,

rw_RW,

se_SE,

sg_CF,

si_LK,

sk_SK,

sl_SI,

sm_AS,

sm_WS,

sn_ZW,

so_DJ,

so_ET,

so_KE,

so_SO,

sq_AL,

sq_ME,

sq_XK,

sr_BA,

sr_ME,

sr_RS,

sr_XK,

ss_SZ,

ss_ZA,

sv_AX,

sv_FI,

sv_SE,

sw_KE,

sw_TZ,

sw_UG,

sw_CD,

ta_IN,

ta_MY,

ta_SG,

ta_LK,

te_IN,

tg_TJ,

th_TH,

ti_ER,

ti_ET,

tig_ER,

tk_TM,

tk_AF,

tn_BW,

tn_ZA,

to_TO,

tr_CY,

tr_TR,

ts_ZA,

uk_UA,

ur_IN,

ur_PK,

uz_AF,

uz_UZ,

ve_ZA,

vi_VN,

xh_ZA,

zh_CN,

zh_HK,

zh_MO,

zh_SG,

zh_TW,

zu_ZA

Example:

"en_GB"

data.avatar.contents.languages.source_value

data.avatar.contents.content_url

string | null

The external URL of the content

Example:

"https://www.youtube.com/watch?v=16873"

data.avatar.contents.content_type

object

The type of content

data.avatar.contents.cover_url

string | null

The URL of the thumbnail image associated with the content.

Example:

"https://www.googledrive.com/?v=16873"

data.avatar.contents.active

boolean | null

Whether the content is active and available for users.

Example:

true

data.avatar.contents.duration

string | null

The duration of the content following the ISO8601 standard. If duration_unit is applicable we will derive this from the smallest unit given in the duration string or the minimum unit accepted by the provider.

Example:

"P3Y6M4DT12H30M5S"

data.avatar.contents.categories

object[] | null

The categories associated with this content

data.avatar.contents.categories.id

string | null

The ID associated with this category

Example:

"16873-IT345"

data.avatar.contents.categories.remote_id

string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.avatar.contents.categories.unified_custom_fields

object | null

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data.avatar.contents.categories.name

string | null

The name associated with this category

Example:

"Information-Technology"

data.avatar.contents.categories.active

boolean | null

Whether the category is active and therefore available for use

Example:

true

data.avatar.contents.categories.level

object

The hierarchal level of the category

data.avatar.contents.categories.language

object

The language associated with this category

Example:

[{ "id": "12345", "name": "Technology" }]

data.avatar.contents.skills

object[] | null

The skills associated with this course

Example:

[
  { "id": "12345", "name": "Sales Techniques" }
]

data.avatar.contents.order

number | null

The order of the individual content within a content grouping. This is not applicable for pushing individual content.

Example:

1

data.avatar.contents.provider

string | null

The name of the content provider

Example:

"Content Provider"

data.avatar.category_id

string | null

The categoryId of the documents

Example:

"6530"

data.avatar.created_at

string | null

The creation date of the file

Example:

"2021-01-01T01:01:01.000Z"

data.avatar.updated_at

string | null

The update date of the file

Example:

"2021-01-02T01:01:01.000Z"

data.avatar.remote_url

string | null

URL where the file content is located

Example:

"https://example.com/file.pdf"

data.avatar.file_format

object

The file format of the file

data.avatar.file_format.value

enum<string> | null

The file format of the file, expressed as a file extension

Available options:

unmapped_value,

ez,

aw,

atom,

atomcat,

atomdeleted,

atomsvc,

dwd,

held,

rsat,

bdoc,

xcs,

ccxml,

cdfx,

cdmia,

cdmic,

cdmid,

cdmio,

cdmiq,

cu,

mpd,

davmount,

dbk,

dssc,

xdssc,

es,

ecma,

emma,

emotionml,

epub,

exi,

exp,

fdt,

pfr,

geojson,

gml,

gpx,

gxf,

gz,

hjson,

stk,

ink,

inkml,

ipfix,

its,

jar,

war,

ear,

ser,

class,

js,

mjs,

json,

map,

json5,

jsonml,

jsonld,

lgr,

lostxml,

hqx,

cpt,

mads,

webmanifest,

mrc,

mrcx,

ma,

nb,

mb,

mathml,

mbox,

mscml,

metalink,

meta4,

mets,

maei,

musd,

mods,

m21,

mp21,

mp4s,

m4p,

doc,

dot,

mxf,

nq,

nt,

cjs,

bin,

dms,

lrf,

mar,

so,

dist,

distz,

pkg,

bpk,

dump,

elc,

deploy,

exe,

dll,

deb,

dmg,

iso,

img,

msi,

msp,

msm,

buffer,

oda,

opf,

ogx,

omdoc,

onetoc,

onetoc2,

onetmp,

onepkg,

oxps,

relo,

xer,

pdf,

pgp,

asc,

sig,

prf,

p10,

p7m,

p7c,

p7s,

p8,

ac,

cer,

crl,

pkipath,

pki,

pls,

ai,

eps,

ps,

provx,

pskcxml,

raml,

rdf,

owl,

rif,

rnc,

rl,

rld,

rs,

rapd,

sls,

rusd,

gbr,

mft,

roa,

rsd,

rss,

rtf,

sbml,

scq,

scs,

spq,

spp,

sdp,

senmlx,

sensmlx,

setpay,

setreg,

shf,

siv,

sieve,

smi,

smil,

rq,

srx,

gram,

grxml,

sru,

ssdl,

ssml,

swidtag,

tei,

teicorpus,

tfi,

tsd,

toml,

trig,

ttml,

ubj,

rsheet,

td,

vxml,

wasm,

wgt,

hlp,

wsdl,

wspolicy,

xaml,

xav,

xca,

xdf,

xel,

xns,

xenc,

xhtml,

xht,

xlf,

xml,

xsl,

xsd,

rng,

dtd,

xop,

xpl,

*xsl,

xslt,

xspf,

mxml,

xhvml,

xvml,

xvm,

yang,

yin,

zip,

*3gpp,

adp,

amr,

au,

snd,

mid,

midi,

kar,

rmi,

mxmf,

*mp3,

m4a,

mp4a,

mpga,

mp2,

mp2a,

mp3,

m2a,

m3a,

oga,

ogg,

spx,

opus,

s3m,

sil,

wav,

*wav,

weba,

xm,

ttc,

otf,

ttf,

woff,

woff2,

exr,

apng,

avif,

bmp,

cgm,

drle,

emf,

fits,

g3,

gif,

heic,

heics,

heif,

heifs,

hej2,

hsj2,

ief,

jls,

jp2,

jpg2,

jpeg,

jpg,

jpe,

jph,

jhc,

jpm,

jpx,

jpf,

jxr,

jxra,

jxrs,

jxs,

jxsc,

jxsi,

jxss,

ktx,

ktx2,

png,

sgi,

svg,

svgz,

t38,

tif,

tiff,

tfx,

webp,

wmf,

disposition-notification,

u8msg,

u8dsn,

u8mdn,

u8hdr,

eml,

mime,

3mf,

gltf,

glb,

igs,

iges,

msh,

mesh,

silo,

mtl,

obj,

stpx,

stpz,

stpxz,

stl,

wrl,

vrml,

*x3db,

x3dbz,

x3db,

*x3dv,

x3dvz,

x3d,

x3dz,

x3dv,

appcache,

manifest,

ics,

ifb,

coffee,

litcoffee,

css,

csv,

html,

htm,

shtml,

jade,

jsx,

less,

markdown,

md,

mml,

mdx,

n3,

txt,

text,

conf,

def,

list,

log,

in,

ini,

rtx,

*rtf,

sgml,

sgm,

shex,

slim,

slm,

spdx,

stylus,

styl,

tsv,

t,

tr,

roff,

man,

me,

ms,

ttl,

uri,

uris,

urls,

vcard,

vtt,

*xml,

yaml,

yml,

3gp,

3gpp,

3g2,

h261,

h263,

h264,

m4s,

jpgv,

*jpm,

jpgm,

mj2,

mjp2,

ts,

mp4,

mp4v,

mpg4,

mpeg,

mpg,

mpe,

m1v,

m2v,

ogv,

qt,

mov,

webm,

cww,

1km,

plb,

psb,

pvb,

tcap,

pwn,

aso,

imp,

acu,

atc,

acutc,

air,

fcdt,

fxp,

fxpl,

xdp,

xfdf,

ahead,

azf,

azs,

azw,

acc,

ami,

apk,

cii,

fti,

atx,

mpkg,

key,

m3u8,

numbers,

pages,

pkpass,

swi,

iota,

aep,

bmml,

mpm,

bmi,

rep,

cdxml,

mmd,

cdy,

csl,

cla,

rp9,

c4g,

c4d,

c4f,

c4p,

c4u,

c11amc,

c11amz,

csp,

cdbcmsg,

cmc,

clkx,

clkk,

clkp,

clkt,

clkw,

wbs,

pml,

ppd,

car,

pcurl,

dart,

rdz,

dbf,

uvf,

uvvf,

uvd,

uvvd,

uvt,

uvvt,

uvx,

uvvx,

uvz,

uvvz,

fe_launch,

dna,

mlp,

mle,

dpg,

dfac,

kpxx,

ait,

svc,

geo,

mag,

nml,

esf,

msf,

qam,

slt,

ssf,

es3,

et3,

ez2,

ez3,

fdf,

mseed,

seed,

dataless,

gph,

ftc,

fm,

frame,

maker,

book,

fnc,

ltf,

fsc,

oas,

oa2,

oa3,

fg5,

bh2,

ddd,

xdw,

xbd,

fzs,

txd,

ggb,

ggt,

gex,

gre,

gxt,

g2w,

g3w,

gmx,

gdoc,

gslides,

gsheet,

kml,

kmz,

gqf,

gqs,

gac,

ghf,

gim,

grv,

gtm,

tpl,

vcg,

hal,

zmm,

hbci,

les,

hpgl,

hpid,

hps,

jlt,

pcl,

pclxl,

sfd-hdstx,

mpy,

afp,

listafp,

list3820,

irm,

sc,

icc,

icm,

igl,

ivp,

ivu,

igm,

xpw,

xpx,

i2g,

qbo,

qfx,

rcprofile,

irp,

xpr,

fcs,

jam,

rms,

jisp,

joda,

ktz,

ktr,

karbon,

chrt,

kfo,

flw,

kon,

kpr,

kpt,

ksp,

kwd,

kwt,

htke,

kia,

kne,

knp,

skp,

skd,

skt,

skm,

sse,

lasxml,

lbd,

lbe,

apr,

pre,

nsf,

org,

scm,

lwp,

portpkg,

mvt,

mcd,

mc1,

cdkey,

mwf,

mfm,

flo,

igx,

mif,

daf,

dis,

mbk,

mqy,

msl,

plc,

txf,

mpn,

mpc,

xul,

cil,

cab,

xls,

xlm,

xla,

xlc,

xlt,

xlw,

xlam,

xlsb,

xlsm,

xltm,

eot,

chm,

ims,

lrm,

thmx,

msg,

cat,

*stl,

ppt,

pps,

pot,

ppam,

pptm,

sldm,

ppsm,

potm,

mpp,

mpt,

docm,

dotm,

wps,

wks,

wcm,

wdb,

wpl,

xps,

mseq,

mus,

msty,

taglet,

nlu,

ntf,

nitf,

nnd,

nns,

nnw,

*ac,

ngdat,

n-gage,

rpst,

rpss,

edm,

edx,

ext,

odc,

otc,

odb,

odf,

odft,

odg,

otg,

odi,

oti,

odp,

otp,

ods,

ots,

odt,

odm,

ott,

oth,

xo,

dd2,

obgx,

oxt,

osm,

pptx,

sldx,

ppsx,

potx,

xlsx,

xltx,

docx,

dotx,

mgp,

dp,

esa,

pdb,

pqa,

oprc,

paw,

str,

ei6,

efif,

wg,

plf,

pbd,

box,

mgz,

qps,

ptid,

qxd,

qxt,

qwd,

qwt,

qxl,

qxb,

rar,

bed,

mxl,

musicxml,

cryptonote,

cod,

rm,

rmvb,

link66,

st,

see,

sema,

semd,

semf,

ifm,

itp,

iif,

ipk,

twd,

twds,

mmf,

teacher,

fo,

sdkm,

sdkd,

dxp,

sfs,

sdc,

sda,

sdd,

smf,

sdw,

vor,

sgl,

smzip,

sm,

wadl,

sxc,

stc,

sxd,

std,

sxi,

sti,

sxm,

sxw,

sxg,

stw,

sus,

susp,

svd,

sis,

sisx,

xsm,

bdm,

xdm,

ddf,

tao,

pcap,

cap,

dmp,

tmo,

tpt,

mxs,

tra,

ufd,

ufdl,

utz,

umj,

unityweb,

uoml,

vcx,

vsd,

vst,

vss,

vsw,

vis,

vsf,

wbxml,

wmlc,

wmlsc,

wtb,

nbp,

wpd,

wqd,

stf,

xar,

xfdl,

hvd,

hvs,

hvp,

osf,

osfpvg,

saf,

spf,

cmp,

zir,

zirz,

zaz,

7z,

abw,

ace,

*dmg,

arj,

aab,

x32,

u32,

vox,

aam,

aas,

bcpio,

*bdoc,

torrent,

blb,

blorb,

bz,

bz2,

boz,

cbr,

cba,

cbt,

cbz,

cb7,

vcd,

cfs,

chat,

pgn,

crx,

cco,

nsc,

cpio,

csh,

*deb,

udeb,

dgc,

dir,

dcr,

dxr,

cst,

cct,

cxt,

w3d,

fgd,

swa,

wad,

ncx,

dtb,

res,

dvi,

evy,

eva,

bdf,

gsf,

psf,

pcf,

snf,

pfa,

pfb,

pfm,

afm,

arc,

spl,

gca,

ulx,

gnumeric,

gramps,

gtar,

hdf,

php,

install,

*iso,

*key,

*numbers,

*pages,

jardiff,

jnlp,

kdbx,

latex,

luac,

lzh,

lha,

run,

mie,

prc,

mobi,

application,

lnk,

wmd,

wmz,

xbap,

mdb,

obd,

crd,

clp,

*exe,

*dll,

com,

bat,

*msi,

mvb,

m13,

m14,

*wmf,

*wmz,

*emf,

emz,

mny,

pub,

scd,

trm,

wri,

nc,

cdf,

pac,

nzb,

pl,

pm,

*prc,

*pdb,

p12,

pfx,

p7b,

spc,

p7r,

*rar,

rpm,

ris,

sea,

sh,

shar,

swf,

xap,

sql,

sit,

sitx,

srt,

sv4cpio,

sv4crc,

t3,

gam,

tar,

tcl,

tk,

tex,

tfm,

texinfo,

texi,

*obj,

ustar,

hdd,

ova,

ovf,

vbox,

vbox-extpack,

vdi,

vhd,

vmdk,

src,

webapp,

der,

crt,

pem,

fig,

*xlf,

xpi,

xz,

z1,

z2,

z3,

z4,

z5,

z6,

z7,

z8,

uva,

uvva,

eol,

dra,

dts,

dtshd,

lvp,

pya,

ecelp4800,

ecelp7470,

ecelp9600,

rip,

aac,

aif,

aiff,

aifc,

caf,

flac,

*m4a,

mka,

m3u,

wax,

wma,

ram,

ra,

rmp,

*ra,

cdx,

cif,

cmdf,

cml,

csml,

xyz,

btif,

pti,

psd,

azv,

uvi,

uvvi,

uvg,

uvvg,

djvu,

djv,

*sub,

dwg,

dxf,

fbs,

fpx,

fst,

mmr,

rlc,

ico,

dds,

mdi,

wdp,

npx,

b16,

tap,

vtf,

wbmp,

xif,

pcx,

3ds,

ras,

cmx,

fh,

fhc,

fh4,

fh5,

fh7,

*ico,

jng,

sid,

*bmp,

*pcx,

pic,

pct,

pnm,

pbm,

pgm,

ppm,

rgb,

tga,

xbm,

xpm,

xwd,

wsc,

dae,

dwf,

gdl,

gtw,

mts,

ogex,

x_b,

x_t,

vds,

usdz,

bsp,

vtu,

dsc,

curl,

dcurl,

mcurl,

scurl,

sub,

fly,

flx,

gv,

3dml,

spot,

jad,

wml,

wmls,

s,

asm,

c,

cc,

cxx,

cpp,

h,

hh,

dic,

htc,

f,

for,

f77,

f90,

hbs,

java,

lua,

mkd,

nfo,

opml,

*org,

p,

pas,

pde,

sass,

scss,

etx,

sfv,

ymp,

uu,

vcs,

vcf,

uvh,

uvvh,

uvm,

uvvm,

uvp,

uvvp,

uvs,

uvvs,

uvv,

uvvv,

dvb,

fvt,

mxu,

m4u,

pyv,

uvu,

uvvu,

viv,

f4v,

fli,

flv,

m4v,

mkv,

mk3d,

mks,

mng,

asf,

asx,

vob,

wm,

wmv,

wmx,

wvx,

avi,

movie,

smv,

ice,

mht

Example:

"pdf"

data.avatar.file_format.source_value

Example:

"abc"

raw

object[] | null

Was this page helpful?

Raise issue

List Users Update User

import { StackOne } from "@stackone/stackone-client-ts";

const stackOne = new StackOne({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await stackOne.iam.getUser({
    id: "<id>",
    fields: "id,remote_id,first_name,last_name,name,primary_email_address,username,roles,groups,status,avatar,is_bot_user,last_active_at,last_login_at,created_at,updated_at,multi_factor_enabled",
    expand: "roles,groups",
    xAccountId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "primary_email_address": "han@stackone.com",
    "first_name": "Han",
    "last_name": "Solo",
    "name": "Han Solo",
    "username": "hansolo1977",
    "is_bot_user": true,
    "roles": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "<string>",
        "description": "<string>",
        "type": {
          "value": "admin",
          "source_value": "<string>"
        },
        "policies": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "name": "Remote Contractor Policy",
            "permissions": [
              {
                "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "name": "read:users",
                "type": {
                  "value": "read_write",
                  "source_value": "<string>"
                },
                "resources": [
                  {
                    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "name": "Company History Records",
                    "location": "s3://bucket-name/folder-name",
                    "type": {
                      "value": "file",
                      "source_value": "<string>"
                    },
                    "description": "<string>",
                    "created_at": "2021-01-01T01:01:01.000Z",
                    "updated_at": "2021-01-01T01:01:01.000Z"
                  }
                ],
                "description": "<string>",
                "created_at": "2021-01-01T01:01:01.000Z",
                "updated_at": "2021-01-01T01:01:01.000Z"
              }
            ],
            "description": "<string>",
            "created_at": "2021-01-01T01:01:01.000Z",
            "updated_at": "2021-01-01T01:01:01.000Z"
          }
        ],
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "groups": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "<string>",
        "description": "<string>",
        "type": {
          "value": "team",
          "source_value": "<string>"
        },
        "roles": [
          {
            "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
            "name": "<string>",
            "description": "<string>",
            "type": {
              "value": "admin",
              "source_value": "<string>"
            },
            "policies": [
              {
                "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                "name": "Remote Contractor Policy",
                "permissions": [
                  {
                    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                    "name": "read:users",
                    "type": {
                      "value": "read_write",
                      "source_value": "<string>"
                    },
                    "resources": [
                      {
                        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
                        "name": "Company History Records",
                        "location": "s3://bucket-name/folder-name",
                        "type": {
                          "value": "file",
                          "source_value": "<string>"
                        },
                        "description": "<string>",
                        "created_at": "2021-01-01T01:01:01.000Z",
                        "updated_at": "2021-01-01T01:01:01.000Z"
                      }
                    ],
                    "description": "<string>",
                    "created_at": "2021-01-01T01:01:01.000Z",
                    "updated_at": "2021-01-01T01:01:01.000Z"
                  }
                ],
                "description": "<string>",
                "created_at": "2021-01-01T01:01:01.000Z",
                "updated_at": "2021-01-01T01:01:01.000Z"
              }
            ],
            "created_at": "2021-01-01T01:01:01.000Z",
            "updated_at": "2021-01-01T01:01:01.000Z"
          }
        ],
        "parent_id": "<string>",
        "remote_parent_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
        "created_at": "2021-01-01T01:01:01.000Z",
        "updated_at": "2021-01-01T01:01:01.000Z"
      }
    ],
    "status": {
      "value": "enabled",
      "source_value": "<string>"
    },
    "last_active_at": "2021-01-01T01:01:01.000Z",
    "last_login_at": "2021-01-01T01:01:01.000Z",
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z",
    "multi_factor_enabled": [
      {
        "value": "totp",
        "source_value": "<string>"
      }
    ],
    "avatar": {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "My Document",
      "path": "/path/to/file",
      "category": "templates, forms, backups, etc.",
      "contents": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "unified_custom_fields": {
            "my_project_custom_field_1": "REF-1236",
            "my_project_custom_field_2": "some other value"
          },
          "external_reference": "SOFTWARE-ENG-LV1-TRAINING-VIDEO-1",
          "course_ids": [
            "16873-SOFTWARE-ENG-COURSE",
            "16874-SOFTWARE-ENG-COURSE"
          ],
          "remote_course_ids": [
            "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
            "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
          ],
          "title": "Software Engineer Lv 1",
          "description": "This video acts as learning content for software engineers.",
          "short_description": "This course is a valuable resource and acts as learning content for...",
          "languages": [
            {
              "value": "en_GB",
              "source_value": "<string>"
            }
          ],
          "content_url": "https://www.youtube.com/watch?v=16873",
          "content_type": {
            "value": "video",
            "source_value": "<string>"
          },
          "cover_url": "https://www.googledrive.com/?v=16873",
          "active": true,
          "duration": "P3Y6M4DT12H30M5S",
          "categories": [
            {
              "id": "12345",
              "name": "Technology"
            }
          ],
          "skills": [
            {
              "id": "12345",
              "name": "Sales Techniques"
            }
          ],
          "order": 1,
          "provider": "Content Provider"
        }
      ],
      "category_id": "6530",
      "created_at": "2021-01-01T01:01:01.000Z",
      "updated_at": "2021-01-02T01:01:01.000Z",
      "remote_url": "https://example.com/file.pdf",
      "file_format": {
        "value": "pdf",
        "source_value": "abc"
      }
    }
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

IAM

Common Guides

API Reference

Authorizations

Headers

Path Parameters

Query Parameters

Response