> 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/security-rights.md).
# Security Rights
## List all users with global security rights
> List all users with global security rights.\
> \
> It is also possible to request a list of archived global admins, that is, users who used to have global security rights, but do not have them now.\
> \
> In order to execute this action the current user must have "security right \`atom:global:assign\_global\_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":{"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":{"/global_admins":{"get":{"callbacks":{},"description":" List all users with global security rights.\n\n It is also possible to request a list of archived global admins, that is, users who used to have global security rights, but do not have them now.\n\n In order to execute this action the current user must have \"security right `atom:global:assign_global_sr_to_user`.\n","parameters":[{"description":"search admins by their email address","in":"query","name":"email","required":false,"schema":{"type":"string"}},{"description":"admin status: `active` or `archived`","in":"query","name":"status","required":false,"schema":{"enum":["active","archived"],"type":"string"}},{"description":"number of admins per page","in":"query","name":"per_page","required":false,"schema":{"type":"integer"}},{"description":"order admins 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"}}],"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 all users with global security rights","tags":["Security Rights"]}}}}
```
## Show a user with global security rights
> Show a user with global security rights\
> \
> In order to execute this action the current user must have "security right \`atom:global:assign\_global\_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":{"/global_admins/{id}":{"get":{"callbacks":{},"description":" Show a user with global security rights\n\n In order to execute this action the current user must have \"security right `atom:global:assign_global_sr_to_user`.\n","parameters":[{"description":"ID of the admin","in":"path","name":"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 a user with global security rights","tags":["Security Rights"]}}}}
```
## Remove all global security rights from a user
> Remove a user from global admins, that is, remove all global security rights from a user.\
> \
> In order to execute this action the current user must have security right \`atom:global:assign\_global\_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":{"/global_admins/{id}":{"delete":{"callbacks":{},"description":" Remove a user from global admins, that is, remove all global security rights from a user.\n\n In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.\n","parameters":[{"description":"ID of the admin","in":"path","name":"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 global security rights from a user","tags":["Security Rights"]}}}}
```
## Archive a global admin
> Remove a user from global admins, and put the admin into the registry of former global admins.\
> \
> In order to execute this action the current user must have security right \`atom:global:assign\_global\_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":{"/global_admins/{id}/archive":{"post":{"callbacks":{},"description":" Remove a user from global admins, and put the admin into the registry of former global admins.\n\n In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.\n","parameters":[{"description":"ID of the admin","in":"path","name":"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 a global admin","tags":["Security Rights"]}}}}
```
## Restore an archived global admin
> Reinstate an archived user and make him/her a global admin again.\
> \
> In order to execute this action the current user must have security right \`atom:global:assign\_global\_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":{"/global_admins/{id}/restore":{"post":{"callbacks":{},"description":" Reinstate an archived user and make him/her a global admin again.\n\n In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.\n","parameters":[{"description":"ID of the admin","in":"path","name":"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 global admin","tags":["Security Rights"]}}}}
```
## Assign global security rights to a user
> Assign global 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:global:assign\_global\_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":{"/global_admins/{id}/security_rights":{"post":{"callbacks":{},"description":" Assign global 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:global:assign_global_sr_to_user`.\n","parameters":[{"description":"ID of a user to whom security rights are assigned","in":"path","name":"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 global security rights to a user","tags":["Security Rights"]}}}}
```
## Remove global security rights from a user
> Remove global security rights from a user.\
> \
> In order to execute this action the current user must have security right \`atom:global:assign\_global\_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":{"/global_admins/{id}/security_rights/{security_rights}":{"delete":{"callbacks":{},"description":" Remove global security rights from a user.\n\n In order to execute this action the current user must have security right `atom:global:assign_global_sr_to_user`.\n","parameters":[{"description":"ID of a user from whom security rights are removed","in":"path","name":"id","required":true,"schema":{"format":"uuid","type":"string"}},{"description":"List of 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 global security rights from a user","tags":["Security Rights"]}}}}
```
## All security rights of the current user
> Show all security rights of the current user for all active tenants and organizations
```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":{"ATOMSecurityRightsOfUser":{"properties":{"orgs":{"description":"Names and IDs of organizations referenced in `security_rights`.","items":{"$ref":"#/components/schemas/ATOMOrgDescription"},"type":"array"},"security_rights":{"description":"Security rights assigned to the user","items":{"$ref":"#/components/schemas/ATOMSecurityRightsGroup"},"type":"array"},"tenants":{"description":"Names and IDs of tenants referenced in `security_rights`.","items":{"$ref":"#/components/schemas/ATOMTenantDescription"},"type":"array"}},"required":["security_rights","tenants","orgs"],"type":"object"},"ATOMOrgDescription":{"properties":{"id":{"description":"ID of an organisation","type":"string"},"name":{"description":"Name of an organisation","type":"string"}},"required":["id","name"],"type":"object"},"ATOMSecurityRightsGroup":{"properties":{"scope":{"$ref":"#/components/schemas/ATOMSecurityRightGroupSpec"},"security_rights":{"description":"list of all security rights","items":{"type":"string"},"type":"array"}},"required":["scope","security_rights"],"type":"object"},"ATOMSecurityRightGroupSpec":{"properties":{"org_id":{"description":"ID of an organisation","nullable":true,"type":"string"},"tenant_id":{"description":"ID of a tenant","nullable":true,"type":"string"}},"required":["tenant_id","org_id"],"type":"object"},"ATOMTenantDescription":{"properties":{"id":{"description":"ID of a tenant","type":"string"},"name":{"description":"Name of a tenant","type":"string"}},"required":["id","name"],"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":{"/security_rights":{"get":{"callbacks":{},"description":"Show all security rights of the current user for all active tenants and organizations","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMSecurityRightsOfUser"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"All security rights of the current user","tags":["Security Rights"]}}}}
```
## Show all security rights known to ATOM
> Show all security rights known to ATOM
```json
{"openapi":"3.0.0","info":{"title":"SVX API","version":"4.0.1"},"servers":[{"url":"https://api-sandbox.svx.exchange"}],"security":[],"paths":{"/security_rights_registry":{"get":{"callbacks":{},"description":"Show all security rights known to ATOM","parameters":[{"description":"By default only active security rights are fetched.\n`with_inactive` allows to retrieve all security rights including inactive.\n","in":"query","name":"with_inactive","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMSecurityRightsRegistry"}}},"description":"Success"}},"summary":"Show all security rights known to ATOM","tags":["Security Rights"]}}},"components":{"schemas":{"ATOMSecurityRightsRegistry":{"properties":{"security_rights":{"description":"security rights known to ATOM","items":{"$ref":"#/components/schemas/ATOMSecurityRightInRegistry"},"type":"array"}},"required":["security_rights"],"type":"object"},"ATOMSecurityRightInRegistry":{"properties":{"security_right":{"description":"security right","type":"string"},"spec":{"$ref":"#/components/schemas/ATOMSecurityRightSpecInRegistry"}},"required":["security_right","spec"],"type":"object"},"ATOMSecurityRightSpecInRegistry":{"properties":{"active":{"description":"Whether the security right is actively used","type":"boolean"},"assigned_by_default":{"description":"Whether the security right should be assigned by default","type":"boolean"},"description":{"description":"Description of the security right","type":"string"},"for_org":{"description":"Whether the security right can only assigned to a user for a specific organisation","type":"boolean"},"for_tenant":{"description":"Whether the security right can only assigned to a user for a specific tenant","type":"boolean"},"internal_atom_security_right":{"description":"Whether the security right is an internal ATOM securuty right","type":"boolean"}},"required":["description","for_org","for_tenant","internal_atom_security_right","active","assigned_by_default"],"type":"object"}}}}
```