# Save Application Users

Save Application Users

Endpoint: POST /rest/2.0/APPLICATION_USER
Version: 1.0
Security: JWT

## Header parameters:

  - `sessionId` (string, required)

## Request fields (application/json; charset=utf-8):

  - `brmObjects` (object)

  - `brmObjects.ResetPasswordFlag` (integer)
    Reset Password

  - `brmObjects.Phone` (string)
    Phone

  - `brmObjects.LastLogout` (string)
    Last Logged Out

  - `brmObjects.Username` (string, required)
    Username

  - `brmObjects.FederationId` (string)
    SSO Federation ID

  - `brmObjects.TimeZoneId` (integer, required)
    Time Zone ID

  - `brmObjects.CollectionsUserFlag` (integer)
    Collections User: If checked, user can be selected as the Collector on an Account

  - `brmObjects.Status` (string)
    Status

  - `brmObjects.Created` (string)
    System controlled field: Date and time the record was created

  - `brmObjects.LandingPage` (string)
    Landing Page: Specify the page a user is taken to immediately after successful login.

  - `brmObjects.ImmediateManager` (integer)
    Immediate Manager

  - `brmObjects.AuthenticationType` (string)
    Two-factor Authentication: Choose Google Authenticator option to require user to input code generated by their Google Authenticator app on their mobile device. IMPORTANT: in cases where BP is able to determine the user was SSO authenticated the MFA prompt will not apply

  - `brmObjects.Last_Name` (string)
    Last Name

  - `brmObjects.LastLogged` (string)
    Last Logged In

  - `brmObjects.ConvertTimeZone` (integer)
    Convert Timestamp to User Time Zone: This will allow them to view localized system times and time stamps. If ticked, all dates and times will be shown in the timezone of the user. Otherwise, the timezone of the user that created/updated the record will be displayed.

  - `brmObjects.AllowAPI` (integer)
    Allow API

  - `brmObjects.UserTag` (string)
    User Tag

  - `brmObjects.First_Name` (string)
    First Name

  - `brmObjects.Title` (string)
    Title

  - `brmObjects.ForbidInternalAuth` (integer)
    Disable Internal Authentication: If you have SSO authentication setup, check this to prevent users from authenticating with the system using credentials stored in BP. The checkbox has no effect when SSO authentication is not in effect

  - `brmObjects.RequireOAuthForAPIAccess` (integer)
    Require OAuth for API Access: When this option is enabled, any inbound API request attempting to authenticate as this user must utilize an Inbound OAuth Key.  Any attempts to authenticate using basic credentials (username/password) will be rejected.  The user may still use username/password on the main BillingPlatform login page.

  - `brmObjects.LastLoggedIp` (string)
    Last Login IP

  - `brmObjects.RegionalSettings` (string)
    RegionalSettings

  - `brmObjects.RoleName` (string)
    Role Name

  - `brmObjects.Email` (string, required)
    Email

  - `brmObjects.ThemeId` (string)
    Theme

  - `brmObjects.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `brmObjects.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `brmObjects.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `brmObjects.LanguageCode` (integer, required)
    LanguageCode

  - `brmObjects.Type` (string)
    Type

  - `brmObjects.RoleStatus` (string)
    RoleStatus

  - `brmObjects.Id` (string, required)
    Id: User id

  - `brmObjects.RoleId` (integer, required)
    RoleId

## Response 200 fields (application/json):

  - `retrieveResponse` (object)

  - `retrieveResponse.ResetPasswordFlag` (integer)
    Reset Password

  - `retrieveResponse.Phone` (string)
    Phone

  - `retrieveResponse.LastLogout` (string)
    Last Logged Out

  - `retrieveResponse.Username` (string)
    Username

  - `retrieveResponse.FederationId` (string)
    SSO Federation ID

  - `retrieveResponse.TimeZoneId` (integer)
    Time Zone ID

  - `retrieveResponse.CollectionsUserFlag` (integer)
    Collections User: If checked, user can be selected as the Collector on an Account

  - `retrieveResponse.Status` (string)
    Status

  - `retrieveResponse.Created` (string)
    System controlled field: Date and time the record was created

  - `retrieveResponse.LandingPage` (string)
    Landing Page: Specify the page a user is taken to immediately after successful login.

  - `retrieveResponse.ImmediateManager` (integer)
    Immediate Manager

  - `retrieveResponse.AuthenticationType` (string)
    Two-factor Authentication: Choose Google Authenticator option to require user to input code generated by their Google Authenticator app on their mobile device. IMPORTANT: in cases where BP is able to determine the user was SSO authenticated the MFA prompt will not apply

  - `retrieveResponse.Last_Name` (string)
    Last Name

  - `retrieveResponse.LastLogged` (string)
    Last Logged In

  - `retrieveResponse.ConvertTimeZone` (integer)
    Convert Timestamp to User Time Zone: This will allow them to view localized system times and time stamps. If ticked, all dates and times will be shown in the timezone of the user. Otherwise, the timezone of the user that created/updated the record will be displayed.

  - `retrieveResponse.AllowAPI` (integer)
    Allow API

  - `retrieveResponse.UserTag` (string)
    User Tag

  - `retrieveResponse.First_Name` (string)
    First Name

  - `retrieveResponse.Title` (string)
    Title

  - `retrieveResponse.ForbidInternalAuth` (integer)
    Disable Internal Authentication: If you have SSO authentication setup, check this to prevent users from authenticating with the system using credentials stored in BP. The checkbox has no effect when SSO authentication is not in effect

  - `retrieveResponse.RequireOAuthForAPIAccess` (integer)
    Require OAuth for API Access: When this option is enabled, any inbound API request attempting to authenticate as this user must utilize an Inbound OAuth Key.  Any attempts to authenticate using basic credentials (username/password) will be rejected.  The user may still use username/password on the main BillingPlatform login page.

  - `retrieveResponse.LastLoggedIp` (string)
    Last Login IP

  - `retrieveResponse.RegionalSettings` (string)
    RegionalSettings

  - `retrieveResponse.RoleName` (string)
    Role Name

  - `retrieveResponse.Email` (string)
    Email

  - `retrieveResponse.ThemeId` (string)
    Theme

  - `retrieveResponse.CreatedUserId` (string)
    System controlled field: Id of the user that created the record

  - `retrieveResponse.UpdatedUserId` (string)
    System controlled field: Id of the last user that updated the record

  - `retrieveResponse.Updated` (string)
    System controlled field: Date and time the record was last updated

  - `retrieveResponse.LanguageCode` (integer)
    LanguageCode

  - `retrieveResponse.Type` (string)
    Type

  - `retrieveResponse.RoleStatus` (string)
    RoleStatus

  - `retrieveResponse.Id` (string)
    Id: User id

  - `retrieveResponse.RoleId` (integer)
    RoleId

## Response 400 fields (application/json):

  - `error` (string)
    Bad request

  - `message` (string)
    Bad request

## Response 401 fields (application/json):

  - `error` (string)
    Unauthorized

  - `message` (string)
    Unauthorized

## Response 404 fields (application/json):

  - `error` (string)
    Not found

  - `message` (string)
    Not found

## Response 429 fields (application/json):

  - `error` (string)
    Too many requests

  - `message` (string)
    Too many requests

## Response 500 fields (application/json):

  - `error` (string)
    Internal error

  - `message` (string)
    Internal error