To enable full automation in your CI/CD pipeline, you can use the Bright API to configure your development and testing flows fully.

More information is provided on our API documentation page: API documentation.

📘

Hint:

For a single status filter, format it as an array using URL encoded markers “%5B%5D”.

How to authorize in Swagger

To authorize in Swagger, click the Authorize as it shown below:

bearer (http, Bearer)

To access the API, you'll need a valid token in the Authorization header.

1. First, get your token by calling the /login endpoint.
2. When you use the token, make sure it looks like this: "Authorization": "Bearer yourTokenHere".

api-key (apiKey)

To access the API, include a valid API key in the Authorization header. Use either a User Key, a Project Key or an Organization Key.

👍

Make sure to prepend the key with Api-Key, like this: "Authorization": "Api-Key myApiKey".

Name: Authorization

Location: header

token (apiKey)

To use the SCIM API, include a valid organization API key with scim scope in the Authorization header.

Name: Authorization

Location: header