> 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/tenants.md). # Tenants ## List all tenants > List all tenants.\ > \ > In order to execute this action the current user must have security right \`atom:global:view\_all\_tenants\`.
```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":{"ATOMPaginatedTenantList":{"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"},"tenants":{"description":"List of tenants","items":{"$ref":"#/components/schemas/ATOMTenant"},"type":"array"}},"required":["tenants"],"type":"object"},"ATOMMeta":{"properties":{},"type":"object"},"ATOMTenant":{"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"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant 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":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","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"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","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":{"/tenants":{"get":{"callbacks":{},"description":" List all tenants.\n\n In order to execute this action the current user must have security right `atom:global:view_all_tenants`.\n","parameters":[{"description":"tenant status: `active`, `archived`, or `all`","in":"query","name":"status","required":false,"schema":{"enum":["active","archived","all"],"type":"string"}},{"description":"number of tenants per page","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"order tenants 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 tenants whose names contains the given string, or by their ID.\n","in":"query","name":"filter_by","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMPaginatedTenantList"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"List all tenants","tags":["Tenants"]}}}} ``` ## Create a tenant > Create a tenant.\ > \ > In order to execute this action the current user must have security right \`atom:global:create\_tenant\`.\ > The current user becomes the first admin of the tenant.
```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":{"ATOMCreateOrUpdateTenantRequest":{"properties":{"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"},"id":{"description":"ID of the tenant. This parameter is optional. If missing, ATOM will choose a random UUID","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":"Name of the tenant","type":"string"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["name"],"type":"object"},"ATOMOneTenant":{"properties":{"tenant":{"$ref":"#/components/schemas/ATOMTenant"}},"required":["tenant"],"type":"object"},"ATOMTenant":{"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"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant 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":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","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"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","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":{"/tenants":{"post":{"callbacks":{},"description":" Create a tenant.\n\n In order to execute this action the current user must have security right `atom:global:create_tenant`.\n The current user becomes the first admin of the tenant.\n","parameters":[{"description":"By default new tenants receive all internal security rights only.\n`with_external_security_rights` also adds all external security rights to the tenant.\n","in":"query","name":"with_external_security_rights","required":false,"schema":{"type":"boolean"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMCreateOrUpdateTenantRequest"}}},"description":"Tenant attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneTenant"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Create a tenant","tags":["Tenants"]}}}} ``` ## Show a tenant > Show a tenant.\ > \ > In order to execute this action the current user must have either global security right \`atom:global:view\_all\_tenants\` or tenant security right \`atom:tenant:view\_tenant\`.
```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":{"/tenants/{tenant_id}":{"get":{"callbacks":{},"description":" Show a tenant.\n\n In order to execute this action the current user must have either global security right `atom:global:view_all_tenants` or tenant security right `atom:tenant:view_tenant`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Show a tenant","tags":["Tenants"]}}}} ``` ## Update a tenant > Update a tenant.\ > \ > In order to execute this action the current user must have security right \`atom:global:create\_tenant\`.\ > \ > It is possible to modify 3 fields:\ > \ > \* \`name\`\ > \* \`logo\_url\`\ > \* \`color\`
```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":{"ATOMCreateOrUpdateTenantRequest":{"properties":{"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"},"id":{"description":"ID of the tenant. This parameter is optional. If missing, ATOM will choose a random UUID","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":"Name of the tenant","type":"string"},"status_in_tenant":{"description":"Status: signed legal agreement received or proof of concept","maxLength":72,"minLength":0,"nullable":true,"type":"string"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["name"],"type":"object"},"ATOMOneTenant":{"properties":{"tenant":{"$ref":"#/components/schemas/ATOMTenant"}},"required":["tenant"],"type":"object"},"ATOMTenant":{"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"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant 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":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","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"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","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":{"/tenants/{tenant_id}":{"put":{"callbacks":{},"description":" Update a tenant.\n\n In order to execute this action the current user must have security right `atom:global:create_tenant`.\n\n It is possible to modify 3 fields:\n\n * `name`\n * `logo_url`\n * `color`\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMCreateOrUpdateTenantRequest"}}},"description":"Tenant attributes","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneTenant"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Frobidden"}},"summary":"Update a tenant","tags":["Tenants"]}}}} ``` ## Delete a tenant > Delete a tenant.\ > \ > In order to execute this action the current user must have security right \`atom:global:create\_tenant\`.
```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":{"/tenants/{tenant_id}":{"delete":{"callbacks":{},"description":" Delete a tenant.\n\n In order to execute this action the current user must have security right `atom:global:create_tenant`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Frobidden"}},"summary":"Delete a tenant","tags":["Tenants"]}}}} ``` ## List admins of a tenant > List admins of a tenant.\ > \ > In order to execute this action the current user must have\ > \ > In order to execute this action the current user must have security right \`atom:tenant:list\_tenant\_admins\` 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":{"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":{"/tenants/{tenant_id}/admins":{"get":{"callbacks":{},"description":" List admins of a tenant.\n\n In order to execute this action the current user must have\n\n In order to execute this action the current user must have security right `atom:tenant:list_tenant_admins` for the tenant with the ID in parameter `tenant_id`\n","parameters":[{"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":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"number of admins per page","in":"query","name":"per_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":" 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"}}],"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 a tenant","tags":["Tenants"]}}}} ``` ## Show an admin of a given tenant > Show an admin of a given tenant\ > \ > In order to execute this action the current user must have security right \`atom:tenant:list\_tenant\_admins\` 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":{"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":{"/tenants/{tenant_id}/admins/{tenant_admin_id}":{"get":{"callbacks":{},"description":" Show an admin of a given tenant\n\n In order to execute this action the current user must have security right `atom:tenant:list_tenant_admins` 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":"ID of the admin","in":"path","name":"tenant_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 tenant","tags":["Tenants"]}}}} ``` ## Remove all tenant security rights from a user > Remove tenant admin privileges from a tenant admin.\ > \ > In order to execute this action the current user must have one of the following security rights:\ > \ > \* \`atom:global:assign\_tenant\_sr\_to\_tenant\_admin\`\ > \* \`atom:tenant:assign\_tenant\_sr\_to\_tenant\_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":{"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}/admins/{tenant_admin_id}":{"delete":{"callbacks":{},"description":" Remove tenant admin privileges from a tenant admin.\n\n In order to execute this action the current user must have one of the following security rights:\n\n * `atom:global:assign_tenant_sr_to_tenant_admin`\n * `atom:tenant:assign_tenant_sr_to_tenant_admin`\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the admin","in":"path","name":"tenant_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":"Unauthorized"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Remove all tenant security rights from a user","tags":["Tenants"]}}}} ``` ## Archive a tenant admin > Remove a user from admins of the given tenant, and put the admin into the registry of former admins of that tenant.\ > \ > In order to execute this action the current user must have one of the following security rights:\ > \ > \* \`atom:global:assign\_tenant\_sr\_to\_tenant\_admin\`\ > \* \`atom:tenant:assign\_tenant\_sr\_to\_tenant\_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":{"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}/admins/{tenant_admin_id}/archive":{"post":{"callbacks":{},"description":" Remove a user from admins of the given tenant, and put the admin into the registry of former admins of that tenant.\n\n In order to execute this action the current user must have one of the following security rights:\n\n * `atom:global:assign_tenant_sr_to_tenant_admin`\n * `atom:tenant:assign_tenant_sr_to_tenant_admin`\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the admin","in":"path","name":"tenant_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":"Unauthorized"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Archive a tenant admin","tags":["Tenants"]}}}} ``` ## Restore an archived tenant admin > Reinstate an archived user and make him/her a tenant admin again.\ > \ > In order to execute this action the current user must have one of the following security rights:\ > \ > \* \`atom:tenant:assign\_tenant\_sr\_to\_tenant\_admin\`\ > \* \`atom:global:assign\_tenant\_sr\_to\_tenant\_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":{"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":{"/tenants/{tenant_id}/admins/{tenant_admin_id}/restore":{"post":{"callbacks":{},"description":" Reinstate an archived user and make him/her a tenant admin again.\n\n In order to execute this action the current user must have one of the following security rights:\n\n * `atom:tenant:assign_tenant_sr_to_tenant_admin`\n * `atom:global:assign_tenant_sr_to_tenant_admin`\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"ID of the admin","in":"path","name":"tenant_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":"Unauthorized"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Restore an archived tenant admin","tags":["Tenants"]}}}} ``` ## Assign tenant security rights to a user > Assign tenant security rights to a user.\ > \ > The user we are assigning security rights to does not need to be known by ATOM.\ > \ > In order to execute this action the current user must have security right \`atom:tenant:assign\_tenant\_sr\_to\_tenant\_admin\` 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":{"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":{"/tenants/{tenant_id}/admins/{tenant_admin_id}/security_rights":{"post":{"callbacks":{},"description":" Assign tenant security rights to a user.\n\n The user we are assigning security rights to does not need to be known by ATOM.\n\n In order to execute this action the current user must have security right `atom:tenant:assign_tenant_sr_to_tenant_admin` 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":"ID of a tenant admin","in":"path","name":"tenant_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 tenant security rights to a user","tags":["Tenants"]}}}} ``` ## Archive a tenant > Archive a tenant.\ > \ > In order to execute this action the current user must have security right \`atom:global:create\_tenant\`.
```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":{"ATOMOneTenant":{"properties":{"tenant":{"$ref":"#/components/schemas/ATOMTenant"}},"required":["tenant"],"type":"object"},"ATOMTenant":{"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"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant 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":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","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"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","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":{"/tenants/{tenant_id}/archive":{"post":{"callbacks":{},"description":" Archive a tenant.\n\n In order to execute this action the current user must have security right `atom:global:create_tenant`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneTenant"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Archive a tenant","tags":["Tenants"]}}}} ``` ## Restore a tenant > Restore a tenant.\ > \ > In order to execute this action the current user must have security right \`atom:global:create\_tenant\`.
```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":{"ATOMOneTenant":{"properties":{"tenant":{"$ref":"#/components/schemas/ATOMTenant"}},"required":["tenant"],"type":"object"},"ATOMTenant":{"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"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant 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":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","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"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","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":{"/tenants/{tenant_id}/restore":{"post":{"callbacks":{},"description":" Restore a tenant.\n\n In order to execute this action the current user must have security right `atom:global:create_tenant`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_id","required":true,"schema":{"format":"uuid","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMOneTenant"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Restore a tenant","tags":["Tenants"]}}}} ``` ## Add security rights to a tenant > Add security rights to a tenant.\ > \ > In order to execute this action the current user must have security right \`atom:global:assign\_sr\_to\_tenant\`.
```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"},"ATOMOneTenant":{"properties":{"tenant":{"$ref":"#/components/schemas/ATOMTenant"}},"required":["tenant"],"type":"object"},"ATOMTenant":{"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"},"created_at":{"description":"When the organisation was created","format":"date-time","type":"string"},"id":{"description":"Tenant 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":"Tenant name","type":"string"},"security_rights":{"description":"list of all security rights assigned to the tenant","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"},"trading_name":{"description":"Trading number","maxLength":72,"minLength":0,"nullable":true,"type":"string"}},"required":["id","archived","name","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":{"/tenants/{tenant_id}/security_rights":{"post":{"callbacks":{},"description":" Add security rights to a tenant.\n\n In order to execute this action the current user must have security right `atom:global:assign_sr_to_tenant`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_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/ATOMOneTenant"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Add security rights to a tenant","tags":["Tenants"]}}}} ``` ## Remove security rights from a tenant > Remove security rights from a tenant.\ > \ > In order to execute this action the current user must have security right \`atom:global:assign\_sr\_to\_tenant\`.
```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":{"/tenants/{tenant_id}/security_rights/{security_rights}":{"delete":{"callbacks":{},"description":" Remove security rights from a tenant.\n\n In order to execute this action the current user must have security right `atom:global:assign_sr_to_tenant`.\n","parameters":[{"description":"ID of the tenant","in":"path","name":"tenant_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 a tenant","tags":["Tenants"]}}}} ```