API - Swagger doc

Owned by Debesh Roy Chowdhury
May 20, 2022
3 min read

The Syndeia Cloud API - Swagger doc page available via the Syndeia Web Dashboard provides the Swagger doc (OpenAPI specification) of the Syndeia Cloud REST/HTTP API.

Sign in to access core services

Follow the steps below to sign in to Syndeia Cloud (local account or LDAP account) to access the core services via their respective endpoints.

Using Syndeia Cloud local account

(1) Use the POST /signIn endpoint to sign in to Syndeia Cloud

(2) Click on the Try it out button on the RHS to edit the Request body. The Try it out button changes to the Cancel button, as shown below.

Provide your Syndeia Cloud username (email) and password, as provided by your Syndeia administrator. Click on the Execute button.

(3) Copy the token value from the response body, as shown below.

(4) Click on the Authorize button on the top RHS.

(5) Paste the token value in the Value field, as shown below, and click the Authorize button.

(6) Now, you should be able to send requests to any of the core endpoints of Syndeia Cloud. The token will be sent automatically in the header. You will need to repeat the sign-in process after the token expires.

Using Syndeia Cloud LDAP account

If your Syndeia Cloud deployment is integrated with your LDAP server, you can use your LDAP username and password to sign in to Syndeia Cloud.

For LDAP sign-in, use the POST /authenticate/{provider} endpoint instead of the POST /signIn endpoint. The remainder of the process is the same as above.

Accessing repository integrations

For using the endpoints available with Syndeia Cloud repository integrations, follow the approach described below.

(1) Use the GET /external/<RepositoryType>/repositories endpoint to get all repositories of the given RepositoryType added/connected to Syndeia Cloud. An example for JIRA is shown below.

Gather the Syndeia key (internal.key) of the specific repository you are interested in from the response.

(2) Use any of the endpoints in that integration and provide the following:

  • repoKey - Syndeia key of the repository you are accessing, e.g. REPO11 for the specific JIRA server/repository, as gathered in the previous step.

  • User-Id - Username for that repository, e.g. the username that you use for signing in to your JIRA repository

  • Ext-Auth-Token - Token/password for that repository, e.g. the API token or password (regular/LDAP) that you use for signing in to that JIRA repository