SIMBA Chain Users API

openapi: 3.2.0
info:
  title: Member Service Users API
  version: 2.10.1
tags:
- name: Users
paths:
  /user_accounts/:
    get:
      tags:
      - Users
      summary: Get User Accounts
      operationId: get_user_accounts_user_accounts__get
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Size
      - name: email
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email
      - name: last_login__gte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Gte
      - name: last_login__lte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Lte
      - name: order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Order By
      - name: default_organisation_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Default Organisation Id
      - name: profile__first_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  First Name
      - name: profile__last_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  Last Name
      - name: profile__user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  User Id
      - name: profile__order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Profile  Order By
      - name: role__id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Role  Id
      - name: role__name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Role  Name
      - name: organisations__display_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Organisations  Display Name
      - name: organisations__order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Organisations  Order By
      - name: organisations__organisation_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Organisations  Organisation Name
      - name: organisations__name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Organisations  Name
      - name: organisations__is_domain
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Organisations  Is Domain
      - name: user__id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: User  Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_OrgScopedUserAccount_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /user_accounts/summary/:
    get:
      tags:
      - Users
      summary: Get User Accounts Summary
      operationId: get_user_accounts_summary_user_accounts_summary__get
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Size
      - name: email
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email
      - name: last_login__gte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Gte
      - name: last_login__lte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Lte
      - name: order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Order By
      - name: profile__first_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  First Name
      - name: profile__last_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  Last Name
      - name: profile__user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  User Id
      - name: profile__order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Profile  Order By
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_UserAccountSummary_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /user_accounts/{user_account_id}:
    get:
      tags:
      - Users
      summary: Get User Account
      operationId: get_user_account_user_accounts__user_account_id__get
      parameters:
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAccount'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
    put:
      tags:
      - Users
      summary: Update Account
      description: '## Update a user account.


        The provided password must be between 12 and 128 characters long.'
      operationId: update_account_user_accounts__user_account_id__put
      parameters:
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserAccountInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
                format: uuid
                title: Response Update Account User Accounts  User Account Id  Put
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
    delete:
      tags:
      - Users
      summary: Delete Account
      operationId: delete_account_user_accounts__user_account_id__delete
      parameters:
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
                format: uuid
                title: Response Delete Account User Accounts  User Account Id  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /user_accounts/whoami/:
    get:
      tags:
      - Users
      summary: Whoami
      operationId: whoami_user_accounts_whoami__get
      parameters: []
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserAccount'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /user_accounts/{user_account_id}/user_profiles/{profile_id}:
    get:
      tags:
      - Users
      summary: Get User Profile
      operationId: get_user_profile_user_accounts__user_account_id__user_profiles__profile_id__get
      parameters:
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Profile Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserProfile'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
    put:
      tags:
      - Users
      summary: Update Profile
      operationId: update_profile_user_accounts__user_account_id__user_profiles__profile_id__put
      parameters:
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      - name: profile_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Profile Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateUserProfileInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
                format: uuid
                title: Response Update Profile User Accounts  User Account Id  User Profiles  Profile Id  Put
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /organisations/{organisation_name}/users/{user_account_id}/roles/:
    put:
      tags:
      - Users
      summary: Update Organisation User Account Roles
      operationId: update_organisation_user_account_roles_organisations__organisation_name__users__user_account_id__roles__put
      parameters:
      - name: organisation_name
        in: path
        required: true
        schema:
          type: string
          title: Organisation Name
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateIdentityRolesInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
                format: uuid
                title: Response Update Organisation User Account Roles Organisations  Organisation Name  Users  User Account Id  Roles  Put
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /organisations/{organisation_name}/users/{user_account_id}/roles/add/:
    post:
      tags:
      - Users
      summary: Add Organisation User Account Roles
      operationId: add_organisation_user_account_roles_organisations__organisation_name__users__user_account_id__roles_add__post
      parameters:
      - name: organisation_name
        in: path
        required: true
        schema:
          type: string
          title: Organisation Name
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddIdentityRolesInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
                format: uuid
                title: Response Add Organisation User Account Roles Organisations  Organisation Name  Users  User Account Id  Roles Add  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /organisations/{organisation_name}/users/{user_account_id}/roles/remove/:
    delete:
      tags:
      - Users
      summary: Remove Organisation User Account Roles
      operationId: remove_organisation_user_account_roles_organisations__organisation_name__users__user_account_id__roles_remove__delete
      parameters:
      - name: organisation_name
        in: path
        required: true
        schema:
          type: string
          title: Organisation Name
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddIdentityRolesInput'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
                format: uuid
                title: Response Remove Organisation User Account Roles Organisations  Organisation Name  Users  User Account Id  Roles Remove  Delete
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /organisations/{organisation_name}/users/:
    get:
      tags:
      - Users
      summary: Get Organisation Users
      operationId: get_organisation_users_organisations__organisation_name__users__get
      parameters:
      - name: organisation_name
        in: path
        required: true
        schema:
          type: string
          title: Organisation Name
      - name: email
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email
      - name: last_login__gte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Gte
      - name: last_login__lte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Lte
      - name: order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Order By
      - name: profile__first_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  First Name
      - name: profile__last_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  Last Name
      - name: profile__user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  User Id
      - name: profile__order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Profile  Order By
      - name: role__id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Role  Id
      - name: role__name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Role  Name
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_OrgScopedUserAccount_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
    post:
      tags:
      - Users
      summary: Admin Add User To Org Domain
      description: '## Adds a user to an organisation or domain with the roles specified

        An admin endpoint to add a new or existing user to an org/domain, bypassing the invite process. A user can be

        added to sub organisations of a domain at the same time with the respective roles.


        Args:

        - `organisation name`: Name of the organisation/domain


        For an organisation or domain for existing user

        ```

        {

        "to_email": "email_of_user@scaas.py",

        "role_ids": ["f4e41abf-09ef-43f7-94c0-33ba51238828", "a4e41abf-09ef-43f7-94c0-33ba51238827"],

        "role_names": ["_Admin", "_OtherRole"],

        "is_default_org": True,

        }

        ```

        For an organisation or domain for existing user

        ```

        {

        "to_email": "email_of_user@scaas.py",

        "role_ids": ["f4e41abf-09ef-43f7-94c0-33ba51238828", "a4e41abf-09ef-43f7-94c0-33ba51238827"],

        "role_names": ["_Admin", "_OtherRole"],

        "user_info": {

        "first_name": "user first name",

        "last_name": "user last name"

        },

        "is_default_org": true

        }

        ```

        For a domain with sub organisations

        ```

        {

        "to_email": "email_of_user@scaas.py",

        "role_ids": ["f4e41abf-09ef-43f7-94c0-33ba51238828", "a4e41abf-09ef-43f7-94c0-33ba51238827"],

        "role_names": ["_Admin", "_OtherRole"],

        "sub_organisations": [

        {

        "organisation_name": "Name of the organisation that belongs to the domain",

        "role_ids": ["list of role ids to assign to the user for the organisation"],

        "role_names": ["list of role names to assign to the user for the organisation"]

        },

        ]

        "user_info": {

        "first_name": "user first name",

        "last_name": "user last name"

        },

        "is_default_org": true

        }

        ```


        Returns:

        - id -UUID of the user.'
      operationId: admin_add_user_to_org_domain_organisations__organisation_name__users__post
      parameters:
      - name: organisation_name
        in: path
        required: true
        schema:
          type: string
          title: Organisation Name
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminAddUserToOrgDomain'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: string
                format: uuid
                title: Response Admin Add User To Org Domain Organisations  Organisation Name  Users  Post
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /organisations/{organisation_name}/users/summary/:
    get:
      tags:
      - Users
      summary: Get Organisation Users Summary
      operationId: get_organisation_users_summary_organisations__organisation_name__users_summary__get
      parameters:
      - name: organisation_name
        in: path
        required: true
        schema:
          type: string
          title: Organisation Name
      - name: email
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: email
          - type: 'null'
          title: Email
      - name: last_login__gte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Gte
      - name: last_login__lte
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login  Lte
      - name: order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Order By
      - name: profile__first_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  First Name
      - name: profile__last_name
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  Last Name
      - name: profile__user_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Profile  User Id
      - name: profile__order_by
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          default: created_at
          title: Profile  Order By
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          default: 1
          title: Page
      - name: size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Size
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Page_UserAccountSummary_'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
  /organisations/{organisation_name}/users/{user_account_id}:
    get:
      tags:
      - Users
      summary: Get Organisation User
      operationId: get_organisation_user_organisations__organisation_name__users__user_account_id__get
      parameters:
      - name: user_account_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: User Account Id
      - name: organisation_name
        in: path
        required: true
        schema:
          type: string
          title: Organisation Name
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrgScopedUserAccount'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - OAuth2AuthorizationCodeBearer: []
components:
  schemas:
    RoleMinimal:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
        name:
          type: string
          title: Name
      type: object
      required:
      - name
      title: RoleMinimal
    OrganisationWithRoles:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
        name:
          type: string
          title: Name
        display_name:
          type: string
          title: Display Name
        is_domain:
          type: boolean
          title: Is Domain
        system_type:
          anyOf:
          - $ref: '#/components/schemas/SystemTypes'
          - type: 'null'
        roles:
          items:
            $ref: '#/components/schemas/RoleMinimal'
          type: array
          title: Roles
      type: object
      required:
      - name
      - display_name
      - is_domain
      - roles
      title: OrganisationWithRoles
    AdminAddUserToOrgDomain:
      properties:
        to_email:
          type: string
          format: email
          title: To Email
          description: Email of the user
        role_ids:
          items:
            type: string
            format: uuid
          type: array
          minItems: 0
          title: Role Ids
          description: List of role ids to assign to user for the organisation/domain
          default: []
        role_names:
          items:
            type: string
          type: array
          minItems: 0
          title: Role Names
          description: List of role names to assign to user for organisation or domain
          default: []
        sub_organisations:
          anyOf:
          - items:
              $ref: '#/components/schemas/CreateInviteSubOrgsInput'
            type: array
            minItems: 0
          - type: 'null'
          title: Sub Organisations
          description: List of sub organisations for the domain
        user_info:
          anyOf:
          - $ref: '#/components/schemas/UpdateUserProfileInput'
          - type: 'null'
          description: Information of the user
        is_default_org:
          anyOf:
          - type: boolean
          - type: 'null'
          title: Is Default Org
          description: Flag to specify default organisation for the user
      type: object
      required:
      - to_email
      title: AdminAddUserToOrgDomain
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    UserProfile:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
        first_name:
          type: string
          title: First Name
        last_name:
          type: string
          title: Last Name
        user_account_id:
          type: string
          format: uuid
          title: User Account Id
      type: object
      required:
      - first_name
      - last_name
      - user_account_id
      title: UserProfile
      description: A model representing a user profile.
    SystemTypes:
      type: string
      enum:
      - ensure
      - build
      - dpp
      - see
      title: SystemTypes
    AddIdentityRolesInput:
      properties:
        role_ids:
          items:
            type: string
            format: uuid
          type: array
          title: Role Ids
          default: []
        role_names:
          items:
            type: string
          type: array
          title: Role Names
          default: []
      type: object
      title: AddIdentityRolesInput
    UserAccount:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
        email:
          type: string
          format: email
          title: Email
        email_verified:
          type: boolean
          title: Email Verified
        last_login:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Login
        profile:
          anyOf:
          - $ref: '#/components/schemas/UserProfile'
          - type: 'null'
        simba_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Simba Id
        default_organisation:
          anyOf:
          - $ref: '#/components/schemas/Organisation'
          - type: 'null'
        terms_accepted_version:
          type: string
          title: Terms Accepted Version
          default: pre-tracking
        totp_enabled_at:
          anyOf:
          - typ

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/simba-chain/refs/heads/main/openapi/simba-chain-users-api-openapi.yml