Skip to main content
POST
/
api
/
v1
/
connected-orgs
Create Connected Org
curl --request POST \
  --url https://api.example.com/api/v1/connected-orgs \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "access_token": "<string>",
  "oauth_org_login": "<string>",
  "platform": "gitlab",
  "url": "<string>"
}
'
{
  "created_at": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "platform": "<string>",
  "platform_id": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "url": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "heuristic_patterns": {},
  "initial_scan_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

​
X-API-Key
string
header
required

Headers

​
X-Workspace-Id
string | null

Cookies

​
riftmap_access
string | null

Body

application/json

Request body for registering a new connected org.

Two mutually exclusive auth modes: PAT mode — provide url + access_token (power users, self-hosted) OAuth mode — provide oauth_org_login (uses the user's linked identity token)

​
name
string
required
​
access_token
string | null
​
oauth_org_login
string | null
​
platform
string
default:gitlab
​
url
string | null

Response

Successful Response

Response schema for a connected org (list/get endpoints).

​
created_at
string<date-time>
required
​
id
string<uuid>
required
​
name
string
required
​
platform
string
required
​
platform_id
string
required
​
updated_at
string<date-time>
required
​
url
string
required
​
workspace_id
string<uuid>
required
​
heuristic_patterns
Heuristic Patterns · object
​
initial_scan_id
string<uuid> | null