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>'
{
"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
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)
"id,remote_id,parent_id,remote_parent_id,name,description,roles,type,created_at,updated_at"
Filter parameters that allow greater customisation of the list response
Use a string with a date to only select results updated after that given date
"2020-01-01T00:00:00.000Z"
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
"2020-01-01T00:00:00.000Z"
The comma separated list of fields that will be expanded in the response
"roles"
Response
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The set of policies associated with the role.
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the policy.
"Remote Contractor Policy"
The set of permissions associated with the policy.
Unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
Provider's unique identifier
"8187e5da-dc77-475e-9949-af0f1fa4e4e3"
The name of the permission.
"read:users"
The resources that the permission applies to.
"2021-01-01T01:01:01.000Z"
"2021-01-01T01:01:01.000Z"
"2021-01-01T01:01:01.000Z"
"2021-01-01T01:01:01.000Z"
"2021-01-01T01:01:01.000Z"
"2021-01-01T01:01:01.000Z"
The parent group id for when a group belongs to another group.
Provider's unique identifier of the parent group id for when a group belongs to another group.
"e3cb75bf-aa84-466e-a6c1-b8322b257a48"
"2021-01-01T01:01:01.000Z"
"2021-01-01T01:01:01.000Z"
Was this page helpful?
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": {}
}
]
}