# Organizations

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.


## Servers

Sandbox environment
```
https://api.sbx.transmitsecurity.io/cis
```

US production environment
```
https://api.transmitsecurity.io/cis
```

EU production environment
```
https://api.eu.transmitsecurity.io/cis
```

CA production environment
```
https://api.ca.transmitsecurity.io/cis
```

AU production environment
```
https://api.au.transmitsecurity.io/cis
```

JP production environment
```
https://api.gasne1-ts01.transmitsecurity.io/cis
```

## Security

### bearer

Type: http
Scheme: bearer
Bearer Format: JWT

### UserAccessToken

A token returned upon end-user authentication, which provides access to resources and data for the user and app for which it was generated

Type: http
Scheme: bearer
Bearer Format: JWT

### AdminAccessToken

[object Object]

Type: oauth2
Token URL: /oidc/token
Scopes:

### ClientAccessToken

[object Object]

Type: oauth2
Token URL: /oidc/token
Scopes:

### OrgAdminAccessToken

A token returned upon B2B authentication for a user that has the organizationAdmin or organizationCreator role.

Type: oauth2
Token URL: /oidc/token
Scopes:

## Download OpenAPI description

 - [Organizations](https://developer.transmitsecurity.com/_bundle/openapi/user/organizations.openapi.yaml)

 - [POST /v1/organizations](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/createorganization.md): 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). <br><br>**Required permis
 - [GET /v1/organizations](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getallorganizations.md): Retrieve a list of all organizations. This should be called from the backend, using an admin access token (generated by a management app). <br><br>**Required permissions**: `organizations:read`, `orgs
 - [GET /v1/organizations/{organization_id}](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getorganization.md): Retrieve an organization by ID. This should be called from the backend, using an admin access token (generated by a management app). <br><br>**Required permissions**: `organizations:read`, `orgs:read`
 - [PUT /v1/organizations/{organization_id}](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/updateorganization.md): Update an organization's basic configuration. This should be called from the backend, using an admin access token (generated by a management app). <br><br>**Required permissions**: `organizations:edit
 - [DELETE /v1/organizations/{organization_id}](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/deleteorganization.md): Delete an organization. This should be called from the backend, using an admin access token (generated by a management app). <br><br>**Required permissions**: `organizations:delete`, `orgs:delete`.
 - [GET /v1/organizations/name/{organization_name}](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getorganizationbyname.md): Retrieve an organization by name. This should be called from the backend, using an admin access token (generated by a management app). <br><br>**Required permissions**: `organizations:read`, `orgs:rea
 - [PUT /v1/organizations/{organization_id}/apps](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/addappstoorganization.md): 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 acces
 - [DELETE /v1/organizations/{organization_id}/apps](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/removeappsfromorganization.md): Remove apps from the organization so its members cannot access them. This should be called from the backend, using an admin access token (generated by a management app). <br><br>**Required permissions
 - [POST /v1/organizations/{organization_id}/logo](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/uploadlogo.md): Upload the organization logo and update the logo URL in the database. This should be called from the backend, using an admin access token (generated by a management app). <br><br>**Required permission
 - [GET /v1/manage/apps/{app_id}/organizations](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getorganizationsbyapp.md): Retrieve all organizations associated with a specific application, including child organizations. This should be called from the backend, using an admin access token (generated by a management app). <
 - [GET /v1/organizations/me/managed-organizations](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getmanagedorganizations.md): Retrieves a paginated list of child organizations for the organization associated with the authenticated user. The parent organization ID is derived from the user access token.
 - [POST /v1/organizations/{organization_id}/applications/{app_id}/managed-organizations](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/createmanagedorganization.md): Create a managed organization in context of a specific app. This should be called from the backend, using an admin access token (generated by a management app) or an organization admin access token. <
 - [GET /v1/organizations/{organization_id}/applications/{app_id}/managed-organizations](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getallmanagedorganization.md): Retrieves a list of all managed organizations. This should be called using a user access token.
 - [GET /v1/organizations/{organization_id}/applications/{app_id}/sso](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getappssoconfiguration.md): Get SSO configuration for specific application in the organization. <br><br>**Required permissions**: `organizations:read`, `orgs:read`.
 - [PUT /v1/organizations/{organization_id}/applications/{app_id}/sso/saml/set](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/setappssosamlconfiguration.md): Set SSO SAML configuration for specific application in the organization. Creates a new configuration if it does not exist, or updates an existing one. <br><br>**Required permissions**: `organizations:
 - [PUT /v1/organizations/{organization_id}/applications/{app_id}/sso/oidc/set](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/setappssooidcconfiguration.md): Set SSO OIDC configuration for specific application in the organization. Creates a new configuration if it does not exist, or updates an existing one. <br><br>**Required permissions**: `organizations:
 - [POST /v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups/set](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/setassignedrolesandgroups.md): Update the roles and role groups of the organization for a specific application, which will replace any existing assignments. These roles and role groups must first be created for the application. Onc
 - [GET /v1/applications/{app_id}/organizations/{organization_id}/roles-and-groups](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getassignedrolesandgroups.md): Retrieves all roles and role groups that were added to the organization for a specific application. Roles that belong to these role groups or are directly assigned can be assigned to members of the or
 - [POST /v1/applications/{app_id}/organizations/{organization_id}/role-groups/set](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/setassignedrolegroups.md): Update the role groups of the organization for a specific application, which will replace any existing role groups for the organization. These role groups must first be created for the application. On
 - [GET /v1/applications/{app_id}/organizations/{organization_id}/role-groups](https://developer.transmitsecurity.com/openapi/user/organizations.openapi/other/getassignedrolegroups.md): Retrieves all role groups that were added to the organization for a specific application. Roles that belong to these role groups can be assigned to members of the organization to control their access