List Groups

GET

unified

iam

groups

curl --request GET \
  --url https://api.stackone.com/unified/iam/groups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next_page": "<string>",
  "next": "<string>",
  "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"
    }
  ],
  "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

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)

Example:

"id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at"

filter

object | null

Filter parameters that allow greater customisation of the list response

page

string | null

deprecated

The page number of the results to fetch

page_size

string | null

default:25

The number of results per page

string | null

The unified cursor

updated_after

string | null

deprecated

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

200

application/json

The list of groups 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.name

string | null

data.description

string | null

data.type

object

data.roles

object[] | null

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

Example:

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

data.updated_at

string | null

Example:

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

next_page

string | null

deprecated

string | null

raw

object[] | null

Was this page helpful?

Suggest edits

Get Group Get Policy

curl --request GET \
  --url https://api.stackone.com/unified/iam/groups \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'x-account-id: <x-account-id>'

{
  "next_page": "<string>",
  "next": "<string>",
  "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"
    }
  ],
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": "<string>",
      "response": {}
    }
  ]
}

IAM

Common Guides

API Reference

Authorizations

Headers

Query Parameters

Response