IAM
Common Guides
API Reference
- Users
- Roles
- Groups
- Policies
List Users
import { StackOne } from "@stackone/stackone-client-ts";
const stackOne = new StackOne({
security: {
username: "",
password: "",
},
});
async function run() {
const result = await stackOne.iam.listUsers({
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",
filter: {
updatedAfter: "2020-01-01T00:00:00.000Z",
},
updatedAfter: "2020-01-01T00:00:00.000Z",
expand: "roles,groups",
xAccountId: "<id>",
});
// Handle the result
console.log(result);
}
run();
{
"next_page": "<string>",
"next": "<string>",
"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
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Headers
The account identifier
Query Parameters
Indicates that the raw request result is returned
Query parameters that can be used to pass through parameters to the underlying provider request by surrounding them with 'proxy' key
The comma separated list of fields that will be returned in the response (if empty, all fields are returned)
Filter parameters that allow greater customisation of the list response
The page number of the results to fetch
The number of results per page
The unified cursor
Use a string with a date to only select results updated after that given date
The comma separated list of fields that will be expanded in the response
Response
The response is of type object
.
Was this page helpful?
import { StackOne } from "@stackone/stackone-client-ts";
const stackOne = new StackOne({
security: {
username: "",
password: "",
},
});
async function run() {
const result = await stackOne.iam.listUsers({
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",
filter: {
updatedAfter: "2020-01-01T00:00:00.000Z",
},
updatedAfter: "2020-01-01T00:00:00.000Z",
expand: "roles,groups",
xAccountId: "<id>",
});
// Handle the result
console.log(result);
}
run();
{
"next_page": "<string>",
"next": "<string>",
"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": {}
}
]
}