GET
/
unified
/
iam
/
users
/
{id}
curl --request GET \
  --url https://api.stackone.com/unified/iam/users/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "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": [
        {
          "url": "https://example.com/file.pdf",
          "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
          "file_format": {
            "value": "pdf",
            "source_value": "application/pdf"
          }
        }
      ],
      "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": "application/pdf"
      }
    }
  },
  "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

​
id
string
required

Query Parameters

​
raw
boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

​
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)

Example:

"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
string | null

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

Example:

"roles,groups"

Response

200
application/json

The user with the given identifier was retrieved.

The response is of type object.

GET
/
unified
/
iam
/
users
/
{id}
curl --request GET \
  --url https://api.stackone.com/unified/iam/users/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'
{
  "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": [
        {
          "url": "https://example.com/file.pdf",
          "unified_url": "https://api.stackone.com/unified/hris/employees/12345/documents/67890/download",
          "file_format": {
            "value": "pdf",
            "source_value": "application/pdf"
          }
        }
      ],
      "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": "application/pdf"
      }
    }
  },
  "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

​
id
string
required

Query Parameters

​
raw
boolean | null

Indicates that the raw request result should be returned in addition to the mapped result (default value is false)

​
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)

Example:

"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
string | null

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

Example:

"roles,groups"

Response

200
application/json

The user with the given identifier was retrieved.

The response is of type object.