{
  "opencollection": "1.0.0",
  "info": {
    "name": "One-Time Login Applications Organizations API",
    "version": "1.0"
  },
  "items": [
    {
      "info": {
        "name": "Organizations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get organizations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations",
            "params": [
              {
                "name": "name",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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:read`, `organizations:list`, `orgs:list`."
        },
        {
          "info": {
            "name": "Create organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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 permissions**: `organizations:create`, `orgs:create`."
        },
        {
          "info": {
            "name": "Get organization by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/:organization_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "ID of the organization to retrieve"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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`."
        },
        {
          "info": {
            "name": "Update organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/:organization_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "ID of the organization to update"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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`, `orgs:edit`."
        },
        {
          "info": {
            "name": "Delete organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/:organization_id",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "The ID of the organization that should be deleted"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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`."
        },
        {
          "info": {
            "name": "Get organization by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/name/:organization_name",
            "params": [
              {
                "name": "organization_name",
                "value": "",
                "type": "path",
                "description": "Name of the organization to retrieve"
              }
            ],
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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:read`."
        },
        {
          "info": {
            "name": "Add apps to organization",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/:organization_id/apps",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "The ID of the organization that should be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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). <br><br>**Required permissions**: `organizations:edit`, `orgs:edit`."
        },
        {
          "info": {
            "name": "Remove apps from organization",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/:organization_id/apps",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "The ID of the organization that should be updated"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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**: `organizations:edit`, `orgs:edit`."
        },
        {
          "info": {
            "name": "Upload organization logo",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/:organization_id/logo",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "ID of the organization to upload the logo for"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": []
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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 permissions**: `organizations:edit`, `orgs:edit`."
        },
        {
          "info": {
            "name": "Create managed organization",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.sbx.transmitsecurity.io/cis/v1/organizations/:organization_id/applications/:app_id/managed-organizations",
            "params": [
              {
                "name": "organization_id",
                "value": "",
                "type": "path",
                "description": "The ID of the organization that creates the managed organization"
              },
              {
                "name": "app_id",
                "value": "",
                "type": "path",
                "description": "ID of application"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "oauth2",
              "flow": "client_credentials",
              "accessTokenUrl": "/oidc/token",
              "credentials": {
                "clientId": "{{clientId}}",
                "clientSecret": "{{clientSecret}}"
              }
            }
          },
          "docs": "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. <br><br>**Required permissions**: `organizations:create`, `orgs:create`."
        }
      ]
    }
  ],
  "bundled": true
}