Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Qwiet rbac API

Roles-based access control (RBAC) allows you to control the permissions users in an organization are granted.The permissions granted to a user are additive. The base level of a user's permission is determined by their role in the organization.A team represents a group of users and the applications that group of users can access. Users are granted additional permissions based on their team role.Users can belong to multiple teams, but an application can only belong to one team.You can use the `TEAM_DEFINED` organization role to limit user access to only the apps assigned to their team.[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/9829310-c002d05e-2fae-4914-8629-54cff59e1e6b?action=collection%2Ffork&collection-url=entityId%3D9829310-c002d05e-2fae-4914-8629-54cff59e1e6b%26entityType%3Dcollection%26workspaceId%3Da63f69cc-5c31-4f2b-8d28-b647f83b9e97)

Qwiet rbac API is one of 27 APIs that Qwiet publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include rbac. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 24 operations across 15 paths, and defines 26 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, https://app.shiftleft.io/api/v4.

24 operations 15 paths 26 schemas 4 DELETE10 GET3 POST7 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://app.shiftleft.io/api/v4
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Qwiet rbac API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (BearerToken).

  • BearerToken — Use of the Qwiet API requires an access token, which is available via the Qwiet Dashboard (either under [Account Settings](https://app.shiftleft.io/user/profil…

Paths & Operations 24

Across 15 paths, the API surfaces 24 operations — 4 DELETE, 10 GET, 3 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

rbac 24

Roles-based access control (RBAC) allows you to control the permissions users in an organization are granted. The permissions granted to a user are additive. The base level of a u…

GET
/orgs/{orgID}/rbac/roles
List roles
ListOrgRBACRoles 2 params → 200default
POST
/orgs/{orgID}/rbac/roles
Create custom RBAC role
CreateCustomRBACRole 2 params body → 201409default
PUT
/orgs/{orgID}/rbac/roles/{rbacRoleID}
Update RBAC role
UpdateRBACRole 2 params body → 200404default
DELETE
/orgs/{orgID}/rbac/roles/{rbacRoleID}
Delete a custom RBAC role
DeleteCustomRBACRole 2 params → 200404default
GET
/orgs/{orgID}/rbac/scopes
List available RBAC scopes
ListAvailableRBACScopes 1 param → 200default
GET
/orgs/{orgID}/rbac/users
List users
ListOrgRBACUsers 8 params → 200default
GET
/orgs/{orgID}/rbac/invitations
List invitations
ListOrgRBACInvitations 6 params → 200default
PUT
/orgs/{orgID}/rbac/users/{userIDv2}
Update user
UpdateOrgUser 3 params body → 200default
DELETE
/orgs/{orgID}/rbac/users/{userIDv2}
Delete user
DeleteOrgUser 2 params → 200409default
GET
/orgs/{orgID}/rbac/groups
List human groups
ListHumanGroups 7 params → 200default
POST
/orgs/{orgID}/rbac/teams
Create team
CreateTeam 2 params body → 200default
GET
/orgs/{orgID}/rbac/teams
List teams
ListTeams 5 params → 200default
PUT
/orgs/{orgID}/rbac/teams/{rbacTeamID}/membership
Update the members of a team
UpdateTeamMembership 3 params body → 200default
PUT
/orgs/{orgID}/rbac/teams/{rbacTeamID}/apps
Update a team's applications
UpdateTeamApps 3 params body → 200default
PUT
/orgs/{orgID}/rbac/teams/{rbacTeamID}/metadata
Update the metadata of a team
UpdateTeamMetadata 3 params body → 200default
GET
/orgs/{orgID}/rbac/teams/{rbacTeamID}
Read team
ReadTeam 4 params → 200default
PUT
/orgs/{orgID}/rbac/teams/{rbacTeamID}
Update a team
UpdateTeam 3 params body → 200default
DELETE
/orgs/{orgID}/rbac/teams/{rbacTeamID}
Delete team
DeleteTeam 3 params body → 200default
GET
/orgs/{orgID}/rbac/teams/{rbacTeamID}/groups
List groups
ListGroups 2 params → 200
PUT
/orgs/{orgID}/rbac/teams/{rbacTeamID}/groups
Create or update group
UpsertGroup 4 params body → 200default
GET
/orgs/{orgID}/rbac/groups/{groupID}
Read group
ReadGroup 4 params → 200default
POST
/orgs/{orgID}/rbac/teams/{rbacTeamID}/groups/{groupID}
Update group
UpdateGroup 6 params body → 200default
DELETE
/orgs/{orgID}/rbac/teams/{rbacTeamID}/groups/{groupID}
Remove group from team
RemoveGroupFromTeam 6 params → 200default
GET
/orgs/{orgID}/rbac/teams/{rbacTeamID}/groups/{groupID}
Read Team group
ReadTeamGroup 6 params → 200default

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are ListRBACUserInfo (8 properties), ListRBACInvitationInfo (4 properties), Error (4 properties), SuccessResponse (1 property). Each schema is shown below with its type and property counts.

ListTeamsResponse
NextPage
string
URL for the next page of results
ListHumanGroupsResponse
object
1 property
GroupAndRole
UpdateTeamMetadataRequest
SuccessResponse
object
1 property 1 required
RBACRole
ReadTeamResponse
UpdateGroupRoleRequest
CreateCustomRBACRoleRequest
UpsertGroupIntoTeamRequest
UpdateRBACRoleRequest
ListRBACUserInfo
object
8 properties
ReadHumanGroupResponse
UpdateTeamRequest
Error
object
4 properties 3 required
RoleType
string
The type of role. This is used to categorize roles and determine in what context they can be used. Team roles can only be used in teams, organization roles can…
ResourceType
string
The type of resource to which the role applies
Scope
string
CreateTeamResponse
UpdateTeamMembershipRequest
CreateTeamRequest
DeleteTeamRequest
UpdateOrganizationUserRequest
ListRBACInvitationInfo
object
4 properties
UpdateTeamAppsRequest

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-rbac-api-openapi.yml Raw ↑

Other APIs Qwiet publishes across the network.

Qwiet alerting API
Qwiet analyze API
Qwiet app_groups API
Qwiet app_labels API
Qwiet apps API
Qwiet autofix API
Qwiet azureboard API
Qwiet branches API
Qwiet comments API
Qwiet compounds API
Qwiet findings API
Qwiet org_backup API