GET
/
unified
/
iam
/
roles
import { StackOne } from "@stackone/stackone-client-ts";

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

async function run() {
  const result = await stackOne.iam.listRoles({
    fields: "id,remote_id,name,type,policies,description,created_at,updated_at",
    filter: {
      updatedAfter: "2020-01-01T00:00:00.000Z",
    },
    updatedAfter: "2020-01-01T00:00:00.000Z",
    expand: "policies",
    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",
      "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"
    }
  ],
  "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)

​
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

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

​
expand
string | null

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

Response

200
application/json
The list of roles was retrieved.
​
data
object[]
required
​
next_page
string | null
deprecated
​
next
string | null
​
raw
object[] | null

Was this page helpful?

Raise issue