IAM Roles

A role gives a user access to resources within a Workspace. Roles are additive, and can combine to configure a custom policy for a Team Member or a Group. A policy is at least one role plus one resource applied to an individual user or group.

List Roles

Returns a list of Roles available to apply to permissions for users and/or groups.

Securitytoken

Request

query Parameters

object (PaginationInput)

Pagination for roles.

This parameter exists in v1.

Example: pagination=pagination.count=2

Responses

200

404

Resource not found

422

Validation failure

429

Too many requests

get/roles

Request samples

TypeScript
Java
Python
Go
curl

import { configureApis, unwrap } from '@segment/public-api-sdk-typescript'

const api = configureApis('/* Insert your Public API token here */')

try {
  const result = await unwrap(api.iamRoles.listRoles())
  console.log(JSON.stringify(result))
} catch (e) {
  console.log('ERROR:', e)
}

Response samples

{"data": {"roles": [{"id": "1WDUuRLxv84rrfCNUwvkrRtkxnS",
"name": "Workspace Owner",
"description": "Owners have full read and edit access to everything in the workspace, including Sources, Destinations, add-on products, and settings. Owners have full edit access to all Team Permissions."
},
{"id": "1aEWAcU0fArxScocwH9xxLgW7r3",
"name": "Minimal Workspace Access",
"description": "Access to view the workspace. Cannot view any sub resources or make changes to the workspace."
}
],
"pagination": {"current": "MA==",
"next": "Mg=="
}
}
}

➔ Next to Tracking Plans