List Groups

curl --request GET \
  --url https://api.stackone.com/unified/iam/groups \
  --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",
      "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"
    }
  ],
  "next_page": "<string>",
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

GET

unified

iam

groups

List Groups

curl --request GET \
  --url https://api.stackone.com/unified/iam/groups \
  --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",
      "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"
    }
  ],
  "next_page": "<string>",
  "next": "<string>",
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "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

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

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,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at,unified_custom_fields"

filter

object

Filter parameters that allow greater customisation of the list response

Show child attributes

filter[updated_after]

string<date-time> | null

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

page

string | null

The page number of the results to fetch

page_size

string | null

The number of results per page (default value is 25)

string | null

The unified cursor

updated_after

string<date-time> | null

Use a string with a date to only select results updated after that given date

Example:

"2020-01-01T00:00:00.000Z"

expand

string | null

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

Example:

"roles"

Response

The list of groups was retrieved.

data

object[]

required

Show child attributes

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.name

string | null

data.description

string | null

data.type

object

Show child attributes

data.type.value

enum<string> | null

Available options:

workspace,

team,

department,

group,

organization,

unmapped_value,

cost_center,

Example:

"team"

data.type.source_value

data.roles

object[] | null

Show child attributes

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

Show child attributes

data.roles.type.value

enum<string> | null

Available options:

admin,

viewer,

editor,

basic,

guest,

unassigned,

restricted,

unmapped_value,

Example:

"admin"

data.roles.type.source_value

data.roles.policies

object[] | null

The set of policies associated with the role.

Show child attributes

data.roles.policies.id

string | null

Unique identifier

Example:

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

data.roles.policies.remote_id

string | null

Provider's unique identifier

Example:

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

data.roles.policies.name

string | null

The name of the policy.

Example:

"Remote Contractor Policy"

data.roles.policies.permissions

object[] | null

The set of permissions associated with the policy.

Show child attributes

data.roles.policies.permissions.id

string | null

Unique identifier

Example:

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

data.roles.policies.permissions.remote_id

string | null

Provider's unique identifier

Example:

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

data.roles.policies.permissions.name

string | null

The name of the permission.

Example:

"read:users"

data.roles.policies.permissions.type

object

Show child attributes

data.roles.policies.permissions.type.value

enum<string> | null

The type of the permission, e.g. read, read_write, delete, etc.

Available options:

read,

read_write,

approve,

delete,

use,

export,

unmapped_value,

Example:

"read_write"

data.roles.policies.permissions.type.source_value

data.roles.policies.permissions.resources

object[] | null

The resources that the permission applies to.

Show child attributes

data.roles.policies.permissions.resources.id

string | null

Unique identifier

Example:

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

data.roles.policies.permissions.resources.remote_id

string | null

Provider's unique identifier

Example:

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

data.roles.policies.permissions.resources.name

string | null

The name of the resource.

Example:

"Company History Records"

data.roles.policies.permissions.resources.location

string | null

The location of the resource.

Example:

"s3://bucket-name/folder-name"

data.roles.policies.permissions.resources.type

object

Show child attributes

data.roles.policies.permissions.resources.type.value

enum<string> | null

The type of the resource, e.g. user, group, permission, etc.

Available options:

project,

file,

folder,

product,

property,

user,

unmapped_value,

Example:

"file"

data.roles.policies.permissions.resources.type.source_value

data.roles.policies.permissions.resources.description

string | null

data.roles.policies.permissions.resources.created_at

string<date-time> | null

Example:

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

data.roles.policies.permissions.resources.updated_at

string<date-time> | null

Example:

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

data.roles.policies.permissions.description

string | null

data.roles.policies.permissions.created_at

string<date-time> | null

Example:

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

data.roles.policies.permissions.updated_at

string<date-time> | null

Example:

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

data.roles.policies.description

string | null

data.roles.policies.created_at

string<date-time> | null

Example:

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

data.roles.policies.updated_at

string<date-time> | null

Example:

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

data.roles.created_at

string<date-time> | null

Example:

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

data.roles.updated_at

string<date-time> | null

Example:

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

data.parent_id

string | null

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

data.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.created_at

string<date-time> | null

Example:

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

data.updated_at

string<date-time> | null

Example:

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

next_page

string | null

deprecated

string | null

raw

object[] | null

Show child attributes

raw.method

string

required

raw.url

string

required

raw.body

object

raw.response

Get Role Get Group

⌘I

Getting Started

API Reference

List Groups

Authorizations

Headers

Query Parameters

Response