Gets a list of Application Users.

/cnbs/v1/apu/users

GET

• Parameters (URI Parameter)
  • User ID (user_id)
    • GUID identifying an application user (Obtained by a Users Search).
  • Login (login)
  • Email (email)
  • User Status (user_status)
  • Profile (profile)
  • Third Party Identifier (third_party_id)
  • Password Reset Token (password_reset_token)
  • Confirmation Token (confirmation_token)
  • Invite Token (invite_token)
  • Search String (search_string)

cURL:

curl -X GET "https://<<your.server.here>>/cnbs/v1/apu/users?sap-client=800&sap-language=EN&apiid=CNBSMV01R -H content-type: application/json -H  cnbssysid: nR4kLO/8HCiuv+1hev5fbMgcMpOwhKf3GvJZvxZ3ZPQ=

The response consists of a user list table (data) and a status (status).

• User List (data)
  • User ID (user_id)
    • System Generated
  • Login Name (login)
  • First Name (first_name)
  • Last Name (last_name)
  • Company (company)
  • Email Address (email)
  • Invite Token (invite_token)
  • Number of Logins (num_logins)
  • Status (status)
  • Password Reset Token (password_reset_token)
  • Salt (salt)
  • Hash (hash)
  • Primary Account Type ID (primary_account_type_id)
  • User Role (user_role)
  • Confirmation Token (confirmation_token)
  • Date Created (created_date)
  • Time Created (created_time)
  • Last Change Date (updated_date)
  • Last Change Time (updated_time)
  • Last Login Date (last_login_date)
  • Last Login Time (last_login_time)
  • Date of Last Password Change (last_pwd_change_date)
  • Time of Last Password Change (last_pwd_change_time)
  • Password Change Required? (require_password_change)
  • Third Party ID (third_party_id)
  • Locked (locked)
  • Failed Login Count (failed_login_count)
  • Last Password Reset (last_password_reset)
  • Regional Format (regional_format)
  • Linked Accounts (linked_accounts)
    • Primary Account (primary_account)
    • Name (name)
• Status (status)
  • Message Type (message_type)
    • SAP Message Type.
      • Errors:
        • E = Error
        • A = Abort
        • X = Exception
      • Others:
        • S = Success
        • W = Warning
        • I = Information
  • Message Identifier (message_identification)
    • SAP Message ID.
  • Message Number (message_number)
    • SAP Message Number.
  • Message Line (message_line_string)
    • SAP Message Text.

{
    "data": [
        {
            "application_id": "CNBSMV01R",
            "user_id": "000C29F0318A1EDE89968D705BD7AB81",
            "login": "adminck",
            "first_name": "Christian",
            "last_name": "Demo",
            "company": "CNBS-IT",
            "email": "demo@demo.com",
            "invite_token": "null",
            "num_logins": 164,
            "status": "active",
            "password_reset_token": "null",
            "salt": "EUr6U8cwKhZEOX5sln5VqA==",
            "hash": "gQiyjh+5kuNc22rUmU8yVCcuRMON0CHmk2HT+jejLis=",
            "primary_account_type_id": "Payer",
            "user_role": "admin",
            "confirmation_token": "",
            "created_date": "20230717",
            "created_time": "081312",
            "updated_date": "20260407",
            "updated_time": "230146",
            "last_login_date": "20260408",
            "last_login_time": "060145",
            "last_pwd_change_date": "20250926",
            "last_pwd_change_time": "094754",
            "require_password_change": "",
            "third_party_id": "",
            "locked": "",
            "failed_login_count": 0,
            "last_password_reset": 20260115114247,
            "regional_format": "US",
            "linked_accounts": [
                {
                    "primary_account": "3000",
                    "name": "Smith Inc. LLC"
                },
                {
                    "primary_account": "4000",
                    "name": "North Energy Ltd"
                }
            ]
        }
    ],
    "status": {
        "message_type": "S",
        "message_identification": "/CNBS/X_API",
        "message_number": 10,
        "message_line_string": "Request successfully processed",
        "json": ""
    }
}