Sign in
latestOpenAPI 3.0.32026-08-10234358.4 KB

3d5d69795558

Roles

Create a role

Create a new role with specified permissions

post/user-service/roles

Request body

namestring required

Role name

descriptionstring nullable

Role description

integrationIdsstring[]

Optional list of integration IDs to restrict role's access to specific integrations

providersstring[]

Optional list of provider types to restrict role's access to specific providers

Example request

{
  "integrationIds": [
    "integration-123",
    "integration-456"
  ],
  "providers": [
    "aws",
    "azure",
    "gcp"
  ],
  "scopes": [
    {
      "scope_id": 4
    }
  ]
}

Response

Created role

idstring uuid required

Unique identifier for the role

account_idstring required

Account identifier this role belongs to

namestring required

Role name

descriptionstring nullable

Role description

integrationIdsstring[]

Optional list of integration IDs to restrict role's access to specific integrations

providersstring[]

Optional list of provider types to restrict role's access to specific providers

team_namesstring[] required

Names of teams that have this role assigned. For Firefly-managed roles, only teams from the requesting account are included.

firefly_managedboolean required

Whether this role is managed by Firefly (system-wide, non-editable role)

created_atstring date-time required

When the role was created

updated_atstring date-time required

When the role was last updated

Example response

{
  "integrationIds": [
    "integration-123",
    "integration-456"
  ],
  "providers": [
    "aws",
    "azure",
    "gcp"
  ],
  "scopes": [
    {
      "scope_id": 4,
      "scope_name": "inventory:read"
    }
  ]
}