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 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).
{- "name": "string",
- "domain": "string",
- "app_ids": [
- "string"
], - "enabled": true
}
{- "result": {
- "organization_id": "string",
- "app_ids": [
- "string"
], - "name": "string",
- "domain": "string",
- "created_at": 0,
- "updated_at": 0,
- "enabled": true,
- "sso": {
- "saml": {
- "service_provider": {
- "acs_url": "string",
- "entity_id": "string"
}, - "identity_provider": {
- "entity_id": "string",
- "sso_url": "string",
- "signing_certificates": [
- "string"
]
}
}
}
}
}
Retrieve a list of all organizations. This should be called from the backend, using an admin access token (generated by a management app).
curl -i -X GET \ https://api.transmitsecurity.io/cis/v1/organizations \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": [
- {
- "organization_id": "string",
- "app_ids": [
- "string"
], - "name": "string",
- "domain": "string",
- "created_at": 0,
- "updated_at": 0,
- "enabled": true,
- "sso": {
- "saml": {
- "service_provider": {
- "acs_url": "string",
- "entity_id": "string"
}, - "identity_provider": {
- "entity_id": "string",
- "sso_url": "string",
- "signing_certificates": [
- "string"
]
}
}
}
}
]
}
Retrieve an organization by ID. This should be called from the backend, using an admin access token (generated by a management app)
curl -i -X GET \ 'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "result": {
- "organization_id": "string",
- "app_ids": [
- "string"
], - "name": "string",
- "domain": "string",
- "created_at": 0,
- "updated_at": 0,
- "enabled": true,
- "sso": {
- "saml": {
- "service_provider": {
- "acs_url": "string",
- "entity_id": "string"
}, - "identity_provider": {
- "entity_id": "string",
- "sso_url": "string",
- "signing_certificates": [
- "string"
]
}
}
}
}
}
Update an organization's basic configuration. This should be called from the backend, using an admin access token (generated by a management app).
{- "name": "string",
- "domain": "string",
- "enabled": true
}
{- "result": {
- "organization_id": "string",
- "app_ids": [
- "string"
], - "name": "string",
- "domain": "string",
- "created_at": 0,
- "updated_at": 0,
- "enabled": true,
- "sso": {
- "saml": {
- "service_provider": {
- "acs_url": "string",
- "entity_id": "string"
}, - "identity_provider": {
- "entity_id": "string",
- "sso_url": "string",
- "signing_certificates": [
- "string"
]
}
}
}
}
}
Delete an organization. This should be called from the backend, using an admin access token (generated by a management app).
curl -i -X DELETE \ 'https://api.transmitsecurity.io/cis/v1/organizations/{organization_id}' \ -H 'Authorization: Bearer <YOUR_JWT_HERE>'
{- "message": "Bad request",
- "error_code": 400
}
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).
{- "app_ids": [
- "string"
]
}
{- "message": "Bad request",
- "error_code": 400
}
Remove apps from the organization so its members cannot access them.
{- "app_ids": [
- "string"
]
}
{- "message": "Bad request",
- "error_code": 400
}
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).
{- "service_provider": {
- "acs_url": "string",
- "entity_id": "string"
}, - "identity_provider": {
- "entity_id": "string",
- "sso_url": "string",
- "signing_certificates": [
- "string"
]
}
}
{- "message": "Bad request",
- "error_code": 400
}