Login
      Contents x
      /Users
      • 24 Jul 2024
      • Print
      • PDF
      Contents

      /Users

      • Updated on 24 Jul 2024
      • Print
      • PDF
      Article summary

      Get
      /Users
      Security
      HTTP
      Type bearer

      Bearer Authorization Token

      Query parameters
      $select
      string
      $filter
      string
      $expand
      string
      $orderby
      string
      $skip
      string
      $top
      string
      $pageNumber
      string
      $limit
      string
      Responses
      200

      Success

      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Array of object
      object
      UserID
      integer (int32)
      AllBranchAccess
      boolean | null
      BranchAccess
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.BranchAccess) | null
      object
      BranchID
      integer (int32)
      BranchName
      string | null
      Max length50
      Min length1
      ExternalContactReference
      string | null
      Max length255
      Min length1
      ContactFirstName
      string | null
      Max length50
      Min length1
      ContactLastName
      string | null
      Max length50
      Min length1
      Active
      boolean | null
      UserRoles
      Array of object (AspireCloud.Domain.Tenant.Users.ODataModel.UserRole) | null
      object
      RoleID
      integer (int32)
      RoleName
      string | null
      Max length50
      Min length1
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout