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 scopes API

Scopes define the type of resource and the operation that you can perform with the access token you bear. For example, `scans:create` means that the bearer of the token with this scope can create scans via the API.For each endpoint, we indicate the scope required to perform an operation under **Authorizations**.We also offer helper endpoints that allow you to determine what the allowed scopes for your access token are in the context of a specific API resource.[![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/9829310-54d0d8f3-0cc0-42c3-8eee-2eb66e1ea835?action=collection%2Ffork&collection-url=entityId%3D9829310-54d0d8f3-0cc0-42c3-8eee-2eb66e1ea835%26entityType%3Dcollection%26workspaceId%3Da63f69cc-5c31-4f2b-8d28-b647f83b9e97)

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

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

This API exposes 3 operations across 3 paths, and defines 3 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.

3 operations 3 paths 3 schemas 3 GET

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 scopes 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 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

scopes 3

Scopes define the type of resource and the operation that you can perform with the access token you bear. For example, scans:create means that the bearer of the token with this sc…

GET
/orgs/{orgID}/my_scopes
List user's org scopes
ListMyOrgScopes 1 param → 200default
GET
/orgs/{orgID}/apps/{appID}/my_scopes
List user's app scopes
ListMyAppScopes 2 params → 200default
GET
/orgs/{orgID}/rbac/teams/{rbacTeamID}/my_scopes
List user's team scopes
ListMyTeamScopes 2 params → 200default

Schemas 3

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

Error
object
4 properties 3 required
SuccessResponse
object
1 property 1 required
Scope
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

qwiet-scopes-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