Organizations

Download OpenAPI specification:Download

In business-to-business (B2B) use cases, organizations represent your business customers and partners. You can manage these organizations, and delegate access so they can manage their own membership. Using member APIs, organizations can manage the profiles of their users, control which apps they can access, and federate login to those apps using their own SAML-based identity providers.

Create organization

Create an organization that represents your business customer or partner. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
Request Body schema: application/json
name
required
string

Name of the organization

domain
required
string

Domain of the organization

app_ids
required
Array of strings

A list of applications the organization can access

enabled
boolean

Indicates if the organization is currently enabled

Responses
201
400
409
post/v1/organizations
Request samples
application/json
{
  • "name": "string",
  • "domain": "string",
  • "app_ids": [
    ],
  • "enabled": true
}
Response samples
application/json
{
  • "result": {
    }
}

Get organizations

Retrieve a list of all organizations. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Responses
200
get/v1/organizations
Request samples
curl -i -X GET \
  https://api.transmitsecurity.io/cis/v1/organizations \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": [
    ]
}

Get organization by ID

Retrieve an organization by ID. This should be called from the backend, using an admin access token (generated by a management app)

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization to retrieve

Responses
200
404
get/v1/organizations/{organization_id}
Request samples
curl -i -X GET \
  'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "result": {
    }
}

Update organization

Update an organization's basic configuration. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

ID of the organization to update

Request Body schema: application/json
name
string

Name of the organization

domain
string

Domain of the organization

enabled
boolean

Indicates if the organization is currently enabled

Responses
200
400
404
put/v1/organizations/{organization_id}
Request samples
application/json
{
  • "name": "string",
  • "domain": "string",
  • "enabled": true
}
Response samples
application/json
{
  • "result": {
    }
}

Delete organization

Delete an organization. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

The ID of the organization that should be deleted

Responses
400
404
delete/v1/organizations/{organization_id}
Request samples
curl -i -X DELETE \
  'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Add apps to organization

Add apps to the organization so its members can access them. If the organization already has apps, this can be used to add additional ones. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

The ID of the organization that should be updated

Request Body schema: application/json
app_ids
required
Array of strings

A list of applications to add the organization to

Responses
204
400
404
put/v1/organizations/{organization_id}/apps
Request samples
application/json
{
  • "app_ids": [
    ]
}
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Remove apps from organization

Remove apps from the organization so its members cannot access them.

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

The ID of the organization that should be updated

Request Body schema: application/json
app_ids
required
Array of strings

A list of applications to add the organization to

Responses
204
400
404
delete/v1/organizations/{organization_id}/apps
Request samples
application/json
{
  • "app_ids": [
    ]
}
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}

Configure SAML SSO

Configures a SAML identity provider for the organization, which can be used to federate login to the apps. This should be called from the backend, using an admin access token (generated by a management app).

SecurityHTTP: bearer
Request
path Parameters
organization_id
required
string

The ID of the organization that should be updated

Request Body schema: application/json
required
object (SAMLServiceProviderConfigurationInput)
required
object (SAMLIdentityProviderConfigurationInput)
Responses
202
400
404
post/v1/organizations/{organization_id}/sso/saml
Request samples
application/json
{
  • "service_provider": {
    },
  • "identity_provider": {
    }
}
Response samples
application/json
{
  • "message": "Bad request",
  • "error_code": 400
}