> For the complete documentation index, see [llms.txt](https://docs.meeco.me/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.meeco.me/openapi-docs/svx-api/organisations.md).
# Organisations
## GET /applications
> Load all application agents
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"paths":{"/applications":{"get":{"description":"Load all application agents","parameters":[{"in":"header","name":"Meeco-Organisation-Id","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"Applications loaded","content":{"application/json":{"schema":{"properties":{"applications":{"items":{"type":"object","properties":{"id":{"type":"string","default":null},"name":{"type":"string","default":null},"description":{"type":"string","default":null},"type":{"type":"string","default":null},"secret":{"type":"string","default":null},"scopes":{"type":"string","default":null},"redirects":{"default":[],"type":"array","items":{"type":"string"}},"logout_redirects":{"default":[],"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean","default":null},"created_at":{"format":"date-time","type":"string","default":null},"updated_at":{"format":"date-time","type":"string","default":null}},"required":["id","name","description","type","secret","scopes","redirects","logout_redirects","is_active","created_at","updated_at"]},"type":"array"}},"type":"object","required":["applications"]}}}}},"tags":["Organisations"]}}}}
```
## POST /applications
> Create application agent
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"paths":{"/applications":{"post":{"description":"Create application agent","parameters":[{"in":"header","name":"Meeco-Organisation-Id","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"201":{"description":"Application created","content":{"application/json":{"schema":{"properties":{"application":{"properties":{"id":{"description":"Agent ID","format":"uuid","type":"string"},"description":{"description":"Agent description","maxLength":256,"minLength":0,"type":"string"},"name":{"description":"Agent name","maxLength":72,"minLength":1,"type":"string"},"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"required":["description","name","id"],"type":"object"}},"type":"object","required":["application"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"application":{"properties":{"description":{"description":"description of the agent","type":"string"},"name":{"description":"name of the agent","type":"string"},"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"type":"object","required":["description","name","security_rights"]}}}}}},"tags":["Organisations"]}}}}
```
## GET /applications/{id}
> Get application agent information
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"paths":{"/applications/{id}":{"get":{"description":"Get application agent information","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"in":"header","name":"Meeco-Organisation-Id","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"One application read","content":{"application/json":{"schema":{"properties":{"application":{"properties":{"id":{"type":"string","default":null},"name":{"type":"string","default":null},"description":{"type":"string","default":null},"type":{"type":"string","default":null},"secret":{"type":"string","default":null},"scopes":{"type":"string","default":null},"redirects":{"default":[],"type":"array","items":{"type":"string"}},"logout_redirects":{"default":[],"type":"array","items":{"type":"string"}},"is_active":{"type":"boolean","default":null},"created_at":{"format":"date-time","type":"string","default":null},"updated_at":{"format":"date-time","type":"string","default":null}},"type":"object","required":["id","name","description","type","secret","scopes","redirects","logout_redirects","is_active","created_at","updated_at"]}},"type":"object","required":["application"]}}}}},"tags":["Organisations"]}}}}
```
## PUT /applications/{id}
> Update application agent
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"paths":{"/applications/{id}":{"put":{"description":"Update application agent","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"in":"header","name":"Meeco-Organisation-Id","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"200":{"description":"Application updated","content":{"application/json":{"schema":{"properties":{"application":{"properties":{"id":{"description":"Agent ID","format":"uuid","type":"string"},"description":{"description":"Agent description","maxLength":256,"minLength":0,"type":"string"},"name":{"description":"Agent name","maxLength":72,"minLength":1,"type":"string"},"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"required":["description","name","id"],"type":"object"}},"type":"object","required":["application"]}}}}},"requestBody":{"content":{"application/json":{"schema":{"properties":{"application":{"properties":{"description":{"description":"description of the agent","type":"string"},"name":{"description":"name of the agent","type":"string"}},"type":"object","required":["description","name"]}},"type":"object","required":["application"]}}}},"tags":["Organisations"]}}}}
```
## DELETE /applications/{id}
> Delete application agent
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}}},"paths":{"/applications/{id}":{"delete":{"description":"Delete application agent","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"in":"header","name":"Meeco-Organisation-Id","schema":{"type":"string","format":"uuid"},"required":true}],"responses":{"204":{"description":"Application agent deleted"}},"tags":["Organisations"]}}}}
```
## View an organisation
> Show an organisation.\
> \
> In order to execute this action the current user must have\
> \
> \* global security \`atom:global:view\_all\_orgs\` or\
> \* security right \`atom:tenant:view\_tenant\_orgs\` for the tenant\
> \* security right \`atom:org:view\_org\` for the org with the ID in parameter \`org\_id\`
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMOneOrg":{"properties":{"org":{"$ref":"#/components/schemas/ATOMOrg"}},"required":["org"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}":{"get":{"callbacks":{},"description":" Show an organisation.\n\n In order to execute this action the current user must have\n\n * global security `atom:global:view_all_orgs` or\n * security right `atom:tenant:view_tenant_orgs` for the tenant\n * security right `atom:org:view_org` for the org with the ID in parameter `org_id`\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneOrg"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"View an organisation","tags":["Organisations"]}}}}
```
## Update an organisation
> Update an organisation.\
> \
> In order to execute this action the current user must have security right \`atom:tenant:create\_org\` for the tenant with the ID in parameter \`tenant\_id\`.\
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMCreateOrUpdateOrgRequest":{"properties":{"authorised_officer_email":{"description":"Authorised officer email","type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","type":"string"},"business_address":{"description":"Business address","type":"string"},"color":{"description":"The color associated with the organisation in the hex format. Used for the UI.","type":"string"},"company_number":{"description":"Company number","type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"legal_name":{"description":"Legal number","type":"string"},"lei_number":{"description":"Legal entity identification number","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation to create","type":"string"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","type":"string"},"trading_name":{"description":"Trading number","type":"string"}},"required":["name"],"type":"object"},"ATOMOneOrg":{"properties":{"org":{"$ref":"#/components/schemas/ATOMOrg"}},"required":["org"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}":{"put":{"callbacks":{},"description":" Update an organisation.\n\n In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.\n\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMCreateOrUpdateOrgRequest"}}},"description":"Organisation attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneOrg"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Forbidden"}},"summary":"Update an organisation","tags":["Organisations"]}}}}
```
## Delete an organisation
> Delete an organisation.\
> \
> In order to execute this action the current user must have security right \`atom:tenant:create\_org\` for the tenant of the organisation.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}":{"delete":{"callbacks":{},"description":" Delete an organisation.\n\n In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Delete an organisation","tags":["Organisations"]}}}}
```
## List admins of an organisation
> List admins of an organisation.\
> \
> It is also possible to request a list of archived admins of the organisation, that is, users who used to have organisation security rights for the given organisation, but do not have them now.\
> \
> In order to execute this action the current user must have\
> \
> \* security right \`atom:org:list\_org\_admins\` for the organisation with the ID in parameter \`org\_id\` or\
> \* security right \`atom:tenant:list\_admins\_of\_all\_orgs\_of\_tenant\` for the parent tenant of the organisation \`org\_id\` or\
> \* global security right \`atom:global:list\_admins\_of\_all\_orgs
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMPaginatedAdminList":{"properties":{"admins":{"description":"List of users","items":{"$ref":"#/components/schemas/ATOMUser"},"type":"array"},"meta":{"$ref":"#/components/schemas/ATOMMeta"},"next_page_after":{"description":"A value which allows to retrieve the next page. (Cursor-based pagination)","nullable":true,"type":"string"}},"required":["admins"],"type":"object"},"ATOMUser":{"properties":{"archived":{"nullable":false,"type":"boolean"},"email":{"description":"user email","nullable":true,"type":"string"},"family_name":{"description":"user family name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"given_name":{"description":"user given name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"ATOMMeta":{"properties":{},"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/admins":{"get":{"callbacks":{},"description":" List admins of an organisation.\n\n It is also possible to request a list of archived admins of the organisation, that is, users who used to have organisation security rights for the given organisation, but do not have them now.\n\n In order to execute this action the current user must have\n\n * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or\n * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or\n * global security right `atom:global:list_admins_of_all_orgs\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"admin status: `active`, or `archived`","in":"query","name":"status","required":false,"schema":{"enum":["active","archived"],"type":"string"}},{"description":"search admins by their email address. Currenty works only with status=archived","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"number of admins per page","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":" Number of the page to serve. This parameter activates classic page-based pagination\n and cannot be used with parameter `next_page_after` which activates cursor-based pagination.\n","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":"order admins by given name in ascending or descending order","in":"query","name":"order","required":false,"schema":{"enum":["asc","desc"],"type":"string"}},{"description":" When cursor based pagination is used, each paginated response has value `next_page_after` which, if submitted\n as a parameter, allows to retrieve the next page. `next_page_after` is `null` is there is no next page.\n `next_page_after` cannot be used together with parameter `page`. `page` activates classic page-based pagination.\n","in":"query","name":"next_page_after","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMPaginatedAdminList"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"List admins of an organisation","tags":["Organisations"]}}}}
```
## Show an admin of a given organisation
> Show an admin of a given organisation.\
> \
> In order to execute this action the current user must have\
> \
> \* security right \`atom:org:list\_org\_admins\` for the organisation with the ID in parameter \`org\_id\` or\
> \* security right \`atom:tenant:list\_admins\_of\_all\_orgs\_of\_tenant\` for the parent tenant of the organisation \`org\_id\` or\
> \* global security right \`atom:global:list\_admins\_of\_all\_orgs
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMAdmin":{"properties":{"admin":{"$ref":"#/components/schemas/ATOMUser"}},"required":["admin"],"type":"object"},"ATOMUser":{"properties":{"archived":{"nullable":false,"type":"boolean"},"email":{"description":"user email","nullable":true,"type":"string"},"family_name":{"description":"user family name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"given_name":{"description":"user given name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/admins/{org_admin_id}":{"get":{"callbacks":{},"description":" Show an admin of a given organisation.\n\n In order to execute this action the current user must have\n\n * security right `atom:org:list_org_admins` for the organisation with the ID in parameter `org_id` or\n * security right `atom:tenant:list_admins_of_all_orgs_of_tenant` for the parent tenant of the organisation `org_id` or\n * global security right `atom:global:list_admins_of_all_orgs\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the admin","in":"path","name":"org_admin_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMAdmin"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Show an admin of a given organisation","tags":["Organisations"]}}}}
```
## Remove all organisation security rights from user
> Remove all organisation security rights from user.\
> \
> In order to execute this action the current user must one of the following security rights:\
> \
> \* \`atom:global:assign\_org\_sr\_to\_user\`\
> \* \`atom:tenant:assign\_org\_sr\_to\_user\`\
> \* \`atom:org:assign\_org\_sr\_to\_user\`
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/admins/{org_admin_id}":{"delete":{"callbacks":{},"description":"Remove all organisation security rights from user.\n\nIn order to execute this action the current user must one of the following security rights:\n\n* `atom:global:assign_org_sr_to_user`\n* `atom:tenant:assign_org_sr_to_user`\n* `atom:org:assign_org_sr_to_user`\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the admin","in":"path","name":"org_admin_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Remove all organisation security rights from user","tags":["Organisations"]}}}}
```
## Archive an organisation admin
> Remove a user from admins of the given organisation, and put the admin into the registry of former admins of that organisation.\
> \
> In order to execute this action the current user must one of the following security rights:\
> \
> \* \`atom:global:assign\_org\_sr\_to\_user\`\
> \* \`atom:tenant:assign\_org\_sr\_to\_user\`\
> \* \`atom:org:assign\_org\_sr\_to\_user\`
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/admins/{org_admin_id}/archive":{"post":{"callbacks":{},"description":"Remove a user from admins of the given organisation, and put the admin into the registry of former admins of that organisation.\n\nIn order to execute this action the current user must one of the following security rights:\n\n* `atom:global:assign_org_sr_to_user`\n* `atom:tenant:assign_org_sr_to_user`\n* `atom:org:assign_org_sr_to_user`\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the admin","in":"path","name":"org_admin_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Archive an organisation admin","tags":["Organisations"]}}}}
```
## Restore an archived organisation admin
> Reinstate an archived user and make him/her a org admin again.\
> \
> In order to execute this action the current user must one of the following security rights:\
> \
> \* \`atom:org:assign\_org\_sr\_to\_user\`\
> \* \`atom:tenant:assign\_org\_sr\_to\_user\`\
> \* \`atom:global:assign\_org\_sr\_to\_user\`
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMAdmin":{"properties":{"admin":{"$ref":"#/components/schemas/ATOMUser"}},"required":["admin"],"type":"object"},"ATOMUser":{"properties":{"archived":{"nullable":false,"type":"boolean"},"email":{"description":"user email","nullable":true,"type":"string"},"family_name":{"description":"user family name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"given_name":{"description":"user given name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"id":{"description":"User ID","format":"uuid","type":"string"}},"required":["id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/admins/{org_admin_id}/restore":{"post":{"callbacks":{},"description":"Reinstate an archived user and make him/her a org admin again.\n\nIn order to execute this action the current user must one of the following security rights:\n\n* `atom:org:assign_org_sr_to_user`\n* `atom:tenant:assign_org_sr_to_user`\n* `atom:global:assign_org_sr_to_user`\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the admin","in":"path","name":"org_admin_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMAdmin"}}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Bad request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Restore an archived organisation admin","tags":["Organisations"]}}}}
```
## List security rights of an organisation admin
> List organisation security rights of a organisation admin.\
> \
> In order to execute this action the current user must have security right \`atom:org:list\_org\_admin\_sr\` for the organisation with the ID in parameter \`org\_id\` or \`atom:tenant:list\_org\_admin\_sr\` for the tenant that the organisation belongs to, or global security right \`atom:global:list\_admin\_sr\_of\_any\_admin\`"
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMSecurityRights":{"properties":{"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"required":["security_rights"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/admins/{org_admin_id}/security_rights":{"get":{"callbacks":{},"description":" List organisation security rights of a organisation admin.\n\n In order to execute this action the current user must have security right `atom:org:list_org_admin_sr` for the organisation with the ID in parameter `org_id` or `atom:tenant:list_org_admin_sr` for the tenant that the organisation belongs to, or global security right `atom:global:list_admin_sr_of_any_admin`\"\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of an organisation admin","in":"path","name":"org_admin_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMSecurityRights"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"List security rights of an organisation admin","tags":["Organisations"]}}}}
```
## Assign organisation security rights to a user
> Assign organisation security rights to a user.\
> \
> The endpoint can process security rights of 2 categories:\
> \
> \* \`for\_org = true\` and \`for\_tenant = false\`\
> \* \`for\_org = true\` and \`for\_tenant = true\`, in this case the security right will be assigned to the tenant which organisation belongs to\
> \
> In order to execute this action the current user must have one of the following security rights:\
> \
> \* security right \`atom:org:assign\_org\_sr\_to\_user\` for the organisation with the ID in parameter \`org\_id\`\
> \* security right \`atom:tenant:assign\_org\_sr\_to\_user\` for the tenant that the organisation belongs to\
> \* global security right \`atom:global:assign\_org\_sr\_to\_user\`"
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMAssignSecurityRightsRequest":{"properties":{"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"required":["security_rights"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/admins/{org_admin_id}/security_rights":{"post":{"callbacks":{},"description":" Assign organisation security rights to a user.\n\n The endpoint can process security rights of 2 categories:\n\n * `for_org = true` and `for_tenant = false`\n * `for_org = true` and `for_tenant = true`, in this case the security right will be assigned to the tenant which organisation belongs to\n\n In order to execute this action the current user must have one of the following security rights:\n\n * security right `atom:org:assign_org_sr_to_user` for the organisation with the ID in parameter `org_id`\n * security right `atom:tenant:assign_org_sr_to_user` for the tenant that the organisation belongs to\n * global security right `atom:global:assign_org_sr_to_user`\"\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of an organisation admin","in":"path","name":"org_admin_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMAssignSecurityRightsRequest"}}},"description":"list of security rights","required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Assign organisation security rights to a user","tags":["Organisations"]}}}}
```
## Archive an organisation
> Archive an organisation.\
> \
> In order to execute this action the current user must have security right \`atom:tenant:create\_org\` for the tenant of the organisation.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMOneOrg":{"properties":{"org":{"$ref":"#/components/schemas/ATOMOrg"}},"required":["org"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/archive":{"post":{"callbacks":{},"description":" Archive an organisation.\n\n In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneOrg"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Archive an organisation","tags":["Organisations"]}}}}
```
## Restore an organisation
> Restore an organisation.\
> \
> In order to execute this action the current user must have security right \`atom:tenant:create\_org\` for the tenant of the organisation.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMOneOrg":{"properties":{"org":{"$ref":"#/components/schemas/ATOMOrg"}},"required":["org"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/restore":{"post":{"callbacks":{},"description":" Restore an organisation.\n\n In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant of the organisation.\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneOrg"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Restore an organisation","tags":["Organisations"]}}}}
```
## Add security rights to an organisation
> Add security rights to an organisation.\
> \
> In order to execute this action the current user must have security right \`atom:tenant:assign\_sr\_to\_org\` for the tenant which the organisation belongs to.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMAssignSecurityRightsRequest":{"properties":{"security_rights":{"description":"list of security rights","items":{"type":"string"},"type":"array"}},"required":["security_rights"],"type":"object"},"ATOMOneOrg":{"properties":{"org":{"$ref":"#/components/schemas/ATOMOrg"}},"required":["org"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/security_rights":{"post":{"callbacks":{},"description":" Add security rights to an organisation.\n\n In order to execute this action the current user must have security right `atom:tenant:assign_sr_to_org` for the tenant which the organisation belongs to.\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMAssignSecurityRightsRequest"}}},"description":"list of security rights","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneOrg"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Add security rights to an organisation","tags":["Organisations"]}}}}
```
## Remove security rights from an organisation
> Remove security rights from an organisation.\
> \
> In order to execute this action the current user must have security right \`atom:tenant:assign\_sr\_to\_org\` for the tenant which the organisation belongs to.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/orgs/{org_id}/security_rights/{security_rights}":{"delete":{"callbacks":{},"description":" Remove security rights from an organisation.\n\n In order to execute this action the current user must have security right `atom:tenant:assign_sr_to_org` for the tenant which the organisation belongs to.\n","parameters":[{"description":"ID of the organisation","in":"path","name":"org_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"Comma-separated security rights to remove","in":"path","name":"security_rights","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{}},"description":"Success"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Remove security rights from an organisation","tags":["Organisations"]}}}}
```
## List organisation in a tenant
> List organisations in a tenant.\
> \
> In order to execute this action the current user must have global security \`atom:global:view\_all\_orgs\` or security right \`atom:tenant:view\_tenant\_orgs\` for the tenant with the ID in parameter \`tenant\_id\`.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMPaginatedOrgList":{"properties":{"meta":{"$ref":"#/components/schemas/ATOMMeta"},"next_page_after":{"description":"A value which allows to retrieve the next page. (Cursor-based pagination)","nullable":true,"type":"string"},"orgs":{"description":"List of orgs","items":{"$ref":"#/components/schemas/ATOMOrg"},"type":"array"}},"required":["orgs"],"type":"object"},"ATOMMeta":{"properties":{},"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/tenants/{tenant_id}/orgs":{"get":{"callbacks":{},"description":" List organisations in a tenant.\n\n In order to execute this action the current user must have global security `atom:global:view_all_orgs` or security right `atom:tenant:view_tenant_orgs` for the tenant with the ID in parameter `tenant_id`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"org status: `active`, `archived`, or `all`","in":"query","name":"status","required":false,"schema":{"enum":["active","archived","all"],"type":"string"}},{"description":"number of organisations per page","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"order organisations by name in ascending or descending order","in":"query","name":"order","required":false,"schema":{"enum":["asc","desc"],"type":"string"}},{"description":" Number of the page to serve. This parameter activates classic page-based pagination\n and cannot be used with parameter `next_page_after` which activates cursor-based pagination.\n","in":"query","name":"page","required":false,"schema":{"type":"integer"}},{"description":" When cursor based pagination is used, each paginated response has value `next_page_after` which, if submitted\n as a parameter, allows to retrieve the next page. `next_page_after` is `null` is there is no next page.\n `next_page_after` cannot be used together with parameter `page`. `page` activates classic page-based pagination.\n","in":"query","name":"next_page_after","required":false,"schema":{"type":"string"}},{"description":" Search organisations whose names contains the given string.\n","in":"query","name":"filter_by","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMPaginatedOrgList"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"List organisation in a tenant","tags":["Organisations"]}}}}
```
## Create an organisation
> Create an organisation.\
> \
> In order to execute this action the current user must have security right \`atom:tenant:create\_org\` for the tenant with the ID in parameter \`tenant\_id\`.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMCreateOrUpdateOrgRequest":{"properties":{"authorised_officer_email":{"description":"Authorised officer email","type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","type":"string"},"business_address":{"description":"Business address","type":"string"},"color":{"description":"The color associated with the organisation in the hex format. Used for the UI.","type":"string"},"company_number":{"description":"Company number","type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"legal_name":{"description":"Legal number","type":"string"},"lei_number":{"description":"Legal entity identification number","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation to create","type":"string"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","type":"string"},"trading_name":{"description":"Trading number","type":"string"}},"required":["name"],"type":"object"},"ATOMOneOrg":{"properties":{"org":{"$ref":"#/components/schemas/ATOMOrg"}},"required":["org"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/tenants/{tenant_id}/orgs":{"post":{"callbacks":{},"description":" Create an organisation.\n\n In order to execute this action the current user must have security right `atom:tenant:create_org` for the tenant with the ID in parameter `tenant_id`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":" If true, the current user will not become the first admin of the organisation, and the organisation will have not admins.\n By default the current user becomes the first admin of the organisation\n","in":"query","name":"no_first_user","required":false,"schema":{"type":"boolean"}},{"description":" By default only all internal org-level security rights of the parent tenant are added to a new organisation\n If this parameter is true, also all external org-level security rights of the parent tenant are added to a new organisation.\n","in":"query","name":"add_all_external_security_rights","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMCreateOrUpdateOrgRequest"}}},"description":"Organisation attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneOrg"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Create an organisation","tags":["Organisations"]}}}}
```
## Show a list of organisations which current user can see.
> Show a list of organisations which the current user can see. These are the following organisations:\
> \
> \* If the current user has global security right \`atom:global:view\_all\_tenants\`, all organisations are shown\
> \* Organisations of all tenants for which the current user has tenant security right \`atom:tenant:view\_tenant\_orgs\`\
> \* Organisations for which current user is an admin and has security right \`atom:org:view\_org\`\
> \
> Can take optional parameter \`tenant\_id\` which will restrict the list of organisations to one tenant only.
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[{"SVX-JWT":[]}],"components":{"securitySchemes":{"SVX-JWT":{"bearerFormat":"JWT","scheme":"bearer","type":"http"}},"schemas":{"ATOMOrgList":{"properties":{"orgs":{"description":"List of orgs","items":{"$ref":"#/components/schemas/ATOMOrg"},"type":"array"}},"required":["orgs"],"type":"object"},"ATOMOrg":{"properties":{"archived":{"format":"uuid","type":"boolean"},"authorised_officer_email":{"description":"Authorised officer email","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_first_name":{"description":"Authorised officer first name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"authorised_officer_last_name":{"description":"Authorised officer last name","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"business_address":{"description":"Business address","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"color":{"description":"The color associated with the tenant. Used for the UI.","maxLength":20,"minLength":0,"nullable":true,"type":"string"},"company_number":{"description":"Company number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"company_url":{"description":"URL of the company","format":"uri","nullable":true,"type":"string"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Organisation ID","format":"uuid","type":"string"},"legal_name":{"description":"Legal number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"lei_number":{"description":"Legal entity identification number","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","nullable":true,"type":"string"},"name":{"description":"Organisation name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the organisation","items":{"type":"string"},"type":"array"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"tenant_id":{"description":"Tenant ID","format":"uuid","type":"string"},"tenant_name":{"description":"Tenant name","minLength":1,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","tenant_id"],"type":"object"},"ATOMError":{"properties":{"args":{"description":"Request parameters","type":"object"},"error":{"description":"Error code","type":"string"},"extra_info":{"description":"Extra info about the error","type":"object"},"file":{"description":"Source file where the error originated in","type":"string"},"http_code":{"description":"HTTP code","type":"integer"},"line":{"description":"Line number in the file where the error originated in","type":"integer"},"message":{"description":"Error code","nullable":true,"type":"string"}},"required":["error","extra_info","args","http_code","message","file","line"],"type":"object"}}},"paths":{"/visible_orgs":{"get":{"callbacks":{},"description":" Show a list of organisations which the current user can see. These are the following organisations:\n\n * If the current user has global security right `atom:global:view_all_tenants`, all organisations are shown\n * Organisations of all tenants for which the current user has tenant security right `atom:tenant:view_tenant_orgs`\n * Organisations for which current user is an admin and has security right `atom:org:view_org`\n\n Can take optional parameter `tenant_id` which will restrict the list of organisations to one tenant only.\n","parameters":[{"description":"This parameter is the ID of a tenant and if present it restricts the list of organisations to one tenant only.","in":"query","name":"tenant_id","required":false,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOrgList"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Show a list of organisations which current user can see.","tags":["Organisations"]}}}}
```