> 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/users.md). # Users ## Show a list of organisations the current user is an admin of > Show a list of organisations the current user is an admin of.\ > Can take optional parameter \`tenant\_id\` which restricts 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":{"ATOMActiveAndArchivedOrgList":{"properties":{"archived_orgs":{"description":"List of archived orgs","items":{"$ref":"#/components/schemas/ATOMOrg"},"type":"array"},"orgs":{"description":"List of active 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":{"/my_orgs":{"get":{"callbacks":{},"description":" Show a list of organisations the current user is an admin of.\n Can take optional parameter `tenant_id` which restricts 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/ATOMActiveAndArchivedOrgList"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Show a list of organisations the current user is an admin of","tags":["Users"]}}}} ``` ## List invitations > \

Requires no security rights\

\
\

Endpoint works for a tenant and organisation user based on the \Meeco-Organisation-ID\ header.\

\

Returns a list of invitations available to the caller.\

\

In case of tenant context, endpoint returns all invitations available in the tenancy.\

\

In case of organization context, endpoint returns all invitations available in the organisations.\

```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":{"PlatformInvitationsResponseDto":{"type":"object","properties":{"invitations":{"type":"array","items":{"$ref":"#/components/schemas/PlatformInvitationResponseModelDto"}},"meta":{"$ref":"#/components/schemas/PlatformMeta"}},"required":["invitations","meta"]},"PlatformInvitationResponseModelDto":{"type":"object","properties":{"id":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","expired"]},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"accepted_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"message":{"type":"string"},"tenant_id":{"type":"string"},"org_id":{"type":"string"},"presentation_request_url":{"type":"string","deprecated":true},"open_id_presentation_request_url":{"type":"string","deprecated":true},"given_name":{"type":"string"},"family_name":{"type":"string"},"email":{"type":"string"}},"required":["id","to","status","token","user_id","created_at","accepted_at","expires_at","message","tenant_id","org_id","presentation_request_url","open_id_presentation_request_url","given_name","family_name","email"]},"PlatformMeta":{"type":"object","properties":{"order_by":{"type":"string"},"order":{"type":"string","enum":["ASC","DESC"]},"order_from_params":{"type":"boolean"},"per_page":{"type":"number"},"per_page_from_params":{"type":"boolean"},"records_count":{"type":"number"},"page":{"type":"number"},"page_count":{"type":"number"}},"required":["order_by","order","order_from_params","per_page","per_page_from_params","records_count","page","page_count"]},"PlatformErrorsResponseModelDto":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PlatformErrorResponseModel"}}},"required":["errors"]},"PlatformErrorResponseModel":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"object"},"http_code":{"type":"number"},"extra_info":{"type":"object"},"requested_language":{"type":"string"},"message_in_requested_language":{"type":"boolean"}},"required":["error","message","http_code","extra_info","requested_language","message_in_requested_language"]}}},"paths":{"/users/invitations":{"get":{"description":"

Requires no security rights


Endpoint works for a tenant and organisation user based on the Meeco-Organisation-ID header.

Returns a list of invitations available to the caller.

In case of tenant context, endpoint returns all invitations available in the tenancy.

In case of organization context, endpoint returns all invitations available in the organisations.

","parameters":[{"name":"status","required":false,"in":"query","description":"Filter invitation by status attribute: e.g. pending,expired.
Available values: pending, accepted, expired.
To filter by more than one status separate values by using comma.","schema":{"type":"string"}},{"name":"Meeco-Organisation-ID","in":"header","description":"Specify Organisation ID to set request context to organisation","required":false,"schema":{"type":"string"}},{"name":"order","required":false,"in":"query","description":"order invitation, Default ordering: `DESC` (Supported: `ASC`, `DESC`) ","schema":{"enum":["ASC","DESC"],"type":"string"}},{"name":"order_by","required":false,"in":"query","description":"order invitation for `columnName`, defaults column: `created_at` (Supported: `given_name`)","schema":{"enum":["given_name"],"type":"string"}},{"name":"per_page","required":false,"in":"query","description":"Number of records per page","schema":{"type":"integer"}},{"name":"page","required":false,"in":"query","description":"Page number (starting from 1)","schema":{"type":"integer"}}],"responses":{"200":{"description":"Invitations successfully listed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformInvitationsResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}}},"summary":"List invitations","tags":["Users"]}}}} ``` ## Invite admin to join the platform > \

Creates an invitation for user to join the platform. If user already exists, he/she will be added to the target organisation or tenant.\

\

Payload example to invite an admin:\

\
\{ \
  "invitation": { \
    "email": "", \
    "given\_name": "Peter", \
    "family\_name": "Peterson", \
  } \
} \
\\
\

Tenant admin will be invited to is determined by the \tid\ attribute value inside the JWT token & empty the \Meeco-Organisation-ID\ query param value in request. \

\

Org admin will be invited to is determined by the \tid\ attribute value inside the JWT token & \Meeco-Organisation-ID\ query param value in request. \

\

Global admin will be invited to is determined by the empty value in \tid\ attribute value inside the JWT token & \Meeco-Organisation-ID\ query param value in request. \

\

The user who is sending the invitations can only invite other users within the tenant or organization they have selected. \

\

For example, if the user is in the tenant context, they can only manage tenant users and invitations. Similarly, in the org context, they can only manage org users and invitations, and in the global context, they can only manage global users and invitations. \

```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":{"PlatformCreateInvitationPayloadDto":{"type":"object","properties":{"invitation":{"$ref":"#/components/schemas/PlatformCreateInvitationDto"}},"required":["invitation"]},"PlatformCreateInvitationDto":{"type":"object","properties":{"email":{"type":"string"},"given_name":{"type":"string"},"family_name":{"type":"string"},"message":{"type":"string","nullable":true}},"required":["email","given_name","family_name"]},"PlatformInvitationResponseDto":{"type":"object","properties":{"invitation":{"$ref":"#/components/schemas/PlatformInvitationResponseModelDto"}},"required":["invitation"]},"PlatformInvitationResponseModelDto":{"type":"object","properties":{"id":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","expired"]},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"accepted_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"message":{"type":"string"},"tenant_id":{"type":"string"},"org_id":{"type":"string"},"presentation_request_url":{"type":"string","deprecated":true},"open_id_presentation_request_url":{"type":"string","deprecated":true},"given_name":{"type":"string"},"family_name":{"type":"string"},"email":{"type":"string"}},"required":["id","to","status","token","user_id","created_at","accepted_at","expires_at","message","tenant_id","org_id","presentation_request_url","open_id_presentation_request_url","given_name","family_name","email"]},"PlatformErrorsResponseModelDto":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PlatformErrorResponseModel"}}},"required":["errors"]},"PlatformErrorResponseModel":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"object"},"http_code":{"type":"number"},"extra_info":{"type":"object"},"requested_language":{"type":"string"},"message_in_requested_language":{"type":"boolean"}},"required":["error","message","http_code","extra_info","requested_language","message_in_requested_language"]}}},"paths":{"/users/invitations":{"post":{"description":"

Creates an invitation for user to join the platform. If user already exists, he/she will be added to the target organisation or tenant.

Payload example to invite an admin:

{ 
  \"invitation\": { 
    \"email\": \"email@meeco.me\", 
    \"given_name\": \"Peter\", 
    \"family_name\": \"Peterson\", 
  } 
}

Tenant admin will be invited to is determined by the tid attribute value inside the JWT token & empty the Meeco-Organisation-ID query param value in request.

Org admin will be invited to is determined by the tid attribute value inside the JWT token & Meeco-Organisation-ID query param value in request.

Global admin will be invited to is determined by the empty value in tid attribute value inside the JWT token & Meeco-Organisation-ID query param value in request.

The user who is sending the invitations can only invite other users within the tenant or organization they have selected.

For example, if the user is in the tenant context, they can only manage tenant users and invitations. Similarly, in the org context, they can only manage org users and invitations, and in the global context, they can only manage global users and invitations.

","parameters":[{"name":"Meeco-Organisation-ID","in":"header","description":"Specify Organisation ID to set request context to organisation","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformCreateInvitationPayloadDto"}}}},"responses":{"201":{"description":"User successfully invited","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformInvitationResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}}},"summary":"Invite admin to join the platform","tags":["Users"]}}}} ``` ## Fetch information about the invitation > Fetch information about the invitation. ```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":{"PlatformInvitationResponseDto":{"type":"object","properties":{"invitation":{"$ref":"#/components/schemas/PlatformInvitationResponseModelDto"}},"required":["invitation"]},"PlatformInvitationResponseModelDto":{"type":"object","properties":{"id":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","expired"]},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"accepted_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"message":{"type":"string"},"tenant_id":{"type":"string"},"org_id":{"type":"string"},"presentation_request_url":{"type":"string","deprecated":true},"open_id_presentation_request_url":{"type":"string","deprecated":true},"given_name":{"type":"string"},"family_name":{"type":"string"},"email":{"type":"string"}},"required":["id","to","status","token","user_id","created_at","accepted_at","expires_at","message","tenant_id","org_id","presentation_request_url","open_id_presentation_request_url","given_name","family_name","email"]},"PlatformErrorsResponseModelDto":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PlatformErrorResponseModel"}}},"required":["errors"]},"PlatformErrorResponseModel":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"object"},"http_code":{"type":"number"},"extra_info":{"type":"object"},"requested_language":{"type":"string"},"message_in_requested_language":{"type":"boolean"}},"required":["error","message","http_code","extra_info","requested_language","message_in_requested_language"]}}},"paths":{"/users/invitations/{id}":{"get":{"description":"Fetch information about the invitation.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"Meeco-Organisation-ID","in":"header","description":"Specify Organisation ID to set request context to organisation","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Invitation information successfully fetched","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformInvitationResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}}},"summary":"Fetch information about the invitation","tags":["Users"]}}}} ``` ## Delete the invitation > Deletes a pending or expired invitation. ```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":{"PlatformErrorsResponseModelDto":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PlatformErrorResponseModel"}}},"required":["errors"]},"PlatformErrorResponseModel":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"object"},"http_code":{"type":"number"},"extra_info":{"type":"object"},"requested_language":{"type":"string"},"message_in_requested_language":{"type":"boolean"}},"required":["error","message","http_code","extra_info","requested_language","message_in_requested_language"]}}},"paths":{"/users/invitations/{id}":{"delete":{"description":"Deletes a pending or expired invitation.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"Meeco-Organisation-ID","in":"header","description":"Specify Organisation ID to set request context to organisation","required":false,"schema":{"type":"string"}}],"responses":{"204":{"description":"Invitation successfully deleted"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}}},"summary":"Delete the invitation","tags":["Users"]}}}} ``` ## Resend invitation > Resend invitation email to the 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":{"PlatformInvitationResponseDto":{"type":"object","properties":{"invitation":{"$ref":"#/components/schemas/PlatformInvitationResponseModelDto"}},"required":["invitation"]},"PlatformInvitationResponseModelDto":{"type":"object","properties":{"id":{"type":"string"},"to":{"type":"string"},"status":{"type":"string","enum":["pending","accepted","expired"]},"token":{"type":"string"},"user_id":{"type":"string"},"created_at":{"format":"date-time","type":"string"},"accepted_at":{"format":"date-time","type":"string"},"expires_at":{"format":"date-time","type":"string"},"message":{"type":"string"},"tenant_id":{"type":"string"},"org_id":{"type":"string"},"presentation_request_url":{"type":"string","deprecated":true},"open_id_presentation_request_url":{"type":"string","deprecated":true},"given_name":{"type":"string"},"family_name":{"type":"string"},"email":{"type":"string"}},"required":["id","to","status","token","user_id","created_at","accepted_at","expires_at","message","tenant_id","org_id","presentation_request_url","open_id_presentation_request_url","given_name","family_name","email"]},"PlatformErrorsResponseModelDto":{"type":"object","properties":{"errors":{"type":"array","items":{"$ref":"#/components/schemas/PlatformErrorResponseModel"}}},"required":["errors"]},"PlatformErrorResponseModel":{"type":"object","properties":{"error":{"type":"string"},"message":{"type":"object"},"http_code":{"type":"number"},"extra_info":{"type":"object"},"requested_language":{"type":"string"},"message_in_requested_language":{"type":"boolean"}},"required":["error","message","http_code","extra_info","requested_language","message_in_requested_language"]}}},"paths":{"/users/invitations/{id}/resend":{"post":{"description":"Resend invitation email to the user.","parameters":[{"name":"id","required":true,"in":"path","schema":{"type":"string"}},{"name":"Meeco-Organisation-ID","in":"header","description":"Specify Organisation ID to set request context to organisation","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Invitation successfuly send","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformInvitationResponseDto"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}},"500":{"description":"Internal server error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorsResponseModelDto"}}}}},"summary":"Resend invitation","tags":["Users"]}}}} ``` ## Update a user detail > This endpoint updates a user detail ```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":{"PlatformUpdateUserPayloadDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/PlatformUpdateUserDto"}},"required":["user"]},"PlatformUpdateUserDto":{"type":"object","properties":{"given_name":{"type":"string"},"family_name":{"type":"string"}}},"PlatformUserResponseDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/PlatformUserDto"}},"required":["user"]},"PlatformUserDto":{"type":"object","properties":{"id":{"type":"string"},"email":{"type":"string"},"email_verified":{"type":"boolean"},"did":{"type":"string"},"jwk_thumbprint_uri":{"type":"string"},"name":{"type":"string"},"given_name":{"type":"string"},"family_name":{"type":"string"},"is_active":{"type":"boolean"},"created_at":{"format":"date-time","type":"string"},"updated_at":{"format":"date-time","type":"string"}},"required":["id","email","email_verified","did","jwk_thumbprint_uri","name","given_name","family_name","is_active","created_at","updated_at"]},"PlatformErrorResponseDto":{"type":"object","properties":{}}}},"paths":{"/users/me":{"put":{"description":"This endpoint updates a user detail","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformUpdateUserPayloadDto"}}}},"responses":{"200":{"description":"User successfuly updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformUserResponseDto"}}}},"400":{"description":"A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorResponseDto"}}}},"500":{"description":"An internal error has occurred. Additional state information plus metadata may be available in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorResponseDto"}}}}},"summary":"Update a user detail","tags":["Users"]}}}} ``` ## Change user password > This endpoint updates a user password ```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":{"PlatformUpdatePasswordPayloadDto":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/PlatformUpdatePasswordDto"}},"required":["user"]},"PlatformUpdatePasswordDto":{"type":"object","properties":{"old_password":{"type":"string"},"new_password":{"type":"string"},"confirm_password":{"type":"string"}},"required":["old_password","new_password","confirm_password"]},"PlatformErrorResponseDto":{"type":"object","properties":{}}}},"paths":{"/users/me/password":{"put":{"description":"This endpoint updates a user password","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformUpdatePasswordPayloadDto"}}}},"responses":{"200":{"description":"User password successfuly updated"},"400":{"description":"A problem with the input fields has occurred. Additional state information plus metadata may be available in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorResponseDto"}}}},"500":{"description":"An internal error has occurred. Additional state information plus metadata may be available in the response body.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformErrorResponseDto"}}}}},"summary":"Change user password","tags":["Users"]}}}} ``` ## Show info about the current user > Show information about the user with a valid JWT:\ > \ > \* User ID from the JWT (taken from \`sub\`)\ > \* Tenant name\ > \* Whether the user is known to ATOM
```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":{"ATOMWhoAmI":{"properties":{"administered_archived_orgs":{"description":"Names and IDs of the archived organizations the user administered","items":{"$ref":"#/components/schemas/ATOMAdministeredArchivedOrg"},"type":"array"},"administered_archived_tenants":{"description":"Names and IDs of the archived tenants the user administered","items":{"$ref":"#/components/schemas/ATOMTenantIdAndName"},"type":"array"},"administered_orgs":{"description":"Names and IDs of the organizations the user administers","items":{"$ref":"#/components/schemas/ATOMAdministeredOrg"},"type":"array"},"administered_tenants":{"description":"Names and IDs of the tenants the user administers","items":{"$ref":"#/components/schemas/ATOMTenantIdAndName"},"type":"array"},"family_name":{"description":"User family name","nullable":true,"type":"string"},"given_name":{"description":"User given name","nullable":true,"type":"string"},"id":{"description":"User ID from the JWT (taken from `sub`)","format":"uuid","type":"string"},"tenant_in_jwt":{"$ref":"#/components/schemas/ATOMTenantInJwtForWhoAmI"},"user_known_to_atom":{"description":"Whether the user is known to ATOM","type":"boolean"},"user_type":{"description":"user, tenant-agent, or org-agent","nullable":true,"type":"string"}},"required":["id","user_known_to_atom","user_type","family_name","given_name","tenant_in_jwt","administered_orgs","administered_tenants"],"type":"object"},"ATOMAdministeredArchivedOrg":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of an organisation","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation","type":"string"},"tenant_active":{"type":"boolean"},"tenant_id":{"description":"ID of the tenant of the organisation","type":"string"}},"required":["id","name","tenant_id","logo_url","color"],"type":"object"},"ATOMTenantIdAndName":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of a tenant","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the tenant","type":"string"}},"required":["id","name","logo_url","color"],"type":"object"},"ATOMAdministeredOrg":{"properties":{"color":{"description":"The color associated with the tenant. Used for the UI.","type":"string"},"id":{"description":"ID of an organisation","type":"string"},"logo_url":{"description":"URL to a logo image","format":"uri","type":"string"},"name":{"description":"Name of the organisation","type":"string"},"tenant_active":{"type":"boolean"},"tenant_id":{"description":"ID of the tenant of the organisation","type":"string"},"user_became_org_admin_at":{"description":"When the user became an admin of the organisation","format":"date-time","type":"string"}},"required":["id","name","tenant_id","logo_url","color"],"type":"object"},"ATOMTenantInJwtForWhoAmI":{"properties":{"tenant_id":{"description":"Tenant ID","format":"uuid","nullable":true,"type":"string"},"tenant_known_to_atom":{"description":"Whether the tenant is registered in ATOM","nullable":true,"type":"boolean"},"tenant_name":{"description":"Tenant name","nullable":true,"type":"string"},"user_became_tenant_admin_at":{"description":"When the user became an admin of the tenant","format":"date-time","nullable":true,"type":"string"}},"required":["tenant_name","tenant_id","tenant_known_to_atom","user_became_tenant_admin_at"],"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":{"/whoami":{"get":{"callbacks":{},"description":" Show information about the user with a valid JWT:\n\n * User ID from the JWT (taken from `sub`)\n * Tenant name\n * Whether the user is known to ATOM\n","parameters":[],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMWhoAmI"}}},"description":"Success"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ATOMError"}}},"description":"Unauthorized"}},"summary":"Show info about the current user","tags":["Users"]}}}} ```