ORGANIZATION

Alle routes relating to Organizations.

All Organizations

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful response

application/json

get

/api/v1/organization

HTTPcURLJavaScriptPython

GET /api/v1/organization HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Create Organization

post

https://api.example.comhttps://staging-api.example.com

/api/v1/organization

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

objectOptionalExample: {"name":"Example Organization"}

Responses

200

Successful response

application/json

post

/api/v1/organization

HTTPcURLJavaScriptPython

POST /api/v1/organization HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "name": "Example Organization"
}

200

Successful response

No content

Single Organization

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/organization/{organizationId}

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Edit Single Organization

put

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 2

Body

application/json

objectOptionalExample: {"name":"Updated Organization Name"}

Responses

200

Successful response

application/json

put

/api/v1/organization/{organizationId}

HTTPcURLJavaScriptPython

PUT /api/v1/organization/{organizationId} HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "name": "Updated Organization Name"
}

200

Successful response

No content

Single Organization - Scopebase

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}/scopebase

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/organization/{organizationId}/scopebase

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/scopebase HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Organization - Scopes

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}/scopes

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/organization/{organizationId}/scopes

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/scopes HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Organization - Debug Scopes

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}/scopes/debug

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/organization/{organizationId}/scopes/debug

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/scopes/debug HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Organization - Active Scopes

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}/scopes/active

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

get

/api/v1/organization/{organizationId}/scopes/active

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/scopes/active HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Single Organization - Users

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}/users/{userId}/count

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 1

userIdintegerRequiredExample: 2

Responses

200

Successful response

application/json

get

/api/v1/organization/{organizationId}/users/{userId}/count

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationId}/users/{userId}/count HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

GET Single Organization Config

get

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationSlug}/configuration

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationSlugstringRequiredExample: example-org

Responses

200

Successful response

application/json

get

/api/v1/organization/{organizationSlug}/configuration

HTTPcURLJavaScriptPython

GET /api/v1/organization/{organizationSlug}/configuration HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content

Save Organization Configuration

post

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationSlug}/configuration/save

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationSlugstringRequiredExample: example-org

Body

application/json

objectOptionalExample: {"config":{"apiKey":"YOUR_API_KEY_HERE","apiBaseUrl":"https://api.provider.com/v1"},"model":"model-name"}

Responses

200

Successful response

application/json

post

/api/v1/organization/{organizationSlug}/configuration/save

HTTPcURLJavaScriptPython

POST /api/v1/organization/{organizationSlug}/configuration/save HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 105

{
  "config": {
    "apiKey": "YOUR_API_KEY_HERE",
    "apiBaseUrl": "https://api.provider.com/v1"
  },
  "model": "model-name"
}

200

Successful response

No content

Delete Single Organization

delete

https://api.example.comhttps://staging-api.example.com

/api/v1/organization/{organizationId}/delete

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdintegerRequiredExample: 1

Responses

200

Successful response

application/json

delete

/api/v1/organization/{organizationId}/delete

HTTPcURLJavaScriptPython

DELETE /api/v1/organization/{organizationId}/delete HTTP/1.1
Host: api.example.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful response

No content