The ADMIN Users API allows management of users within an ADMIN environment.

The ADMIN Users API allows users to be managed in an ADMIN environment. In this document, the term "User" will refer to an ADMIN user in a specific environment/tenant, whereas "IdP

All API calls must include the necessary authorization information, which is described in detail in the API Access page.

In the following examples, the format {{VALUE}} will be used to represent places that you need to replace with your specific value, commonly API_KEY and JWT_TOKEN. Additionally, common headers such as Host and Content-Length are omitted from the example for sake of brevity, but must be included in your requests as per the OpenAPI documentation and HTTP specification.

Terminology

User: A user in an ADMIN environment/instance/tenant.

IdP User: A user record in an Identity Provider outside of the ADMIN system, used for modern authentication including security such as Multi Factor Authentication, SSO, and identity federation.

External Identity: A reference in ADMIN's database/records pointing to an IdP User that will be assumed when a user logs in via any supported Identity Provider method.

API Endpoints

GET /v1/seadminusers

Purpose: Search for users based on specified criteria.

OpenAPI Reference: GET /v1/seadminusers

To search for users, the following criteria are available. All are exact-match only.

Parameter	Description
searchData.id	The integer ID of the target user.
searchData.emailAddress	The email address of the target user.
searchData.externalIdentity	The External Identity of the target user.

Responses are returned in the format document here.

POST /v1/seadminusers

Purpose: Create a new user, including their roles and groups.

OpenAPI Reference: POST /v1/seadminusers

GET /v1/seadminusers/{userId}

Purpose: Retrieve a single user by the user's integer ID.

OpenAPI Reference: GET /v1/seadminusers/{userId}

PUT /v1/seadminusers/{userId}

Purpose: Update an existing user by providing values for all fields, including their roles and groups.

**OpenAPI Reference: **PUT /v1/seadminusers/{userId}

Examples

Create a new user (POST /v1/seadminusers)

POST /v1/seadminusers HTTP/1.1
x-api-key: {{API_KEY}}
Content-Type: application/json
Authorization: Bearer {{JWT_TOKEN}}

{
"userType": "Administrator",
"emailAddress": "bob_smith@somedomain.test",
"name": "Bob Smith",
"userName": "bob_smith@somedomain.test",
"membershipGroups": [
{
"membershipGroupId": 1
}
],
"membershipRoles": [
{
"membershipRoleId": 686
}
]
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"userType": "Administrator",
"preferredTransactionType": null,
"id": 43247,
"emailAddress": "bob_smith@somedomain.test",
"externalIdentity": "bob_smith@somedomain.test",
"userName": "bob_smith@somedomain.test",
"name": "Bob Smith",
"legalName": null,
"accountCode": null,
"systemCode": null,
"taxId": null,
"billingAddress": null,
"physicalAddress": null,
"isActive": true,
"isFiltered": false,
"emailOptIn": false,
"membershipGroups": [
{
"membershipGroupId": 1,
"name": "Administrator",
"description": "Has all permissions",
"roles": null,
"users": null
}
],
"membershipRoles": [
{
"membershipRoleId": 686,
"name": "AccountingForAnyLedgerType",
"description": "Allows a user to view and pay/receive any ledger type in Accounts Payable/Accounts Receiveable. Must be used in conjunction with Create Payments or Create Receivables. Must be used in conjunction with Full Remit or Remit Based Rules.",
"fxRoleCategoryId": null,
"users": null
}
],
"expiredDate": null
}

Search for Users by Email Address (GET /v1/seadminusers)

GET /v1/seadminusers/?EmailAddress=bob_smith%40somedomain.test HTTP/1.1
x-api-key: {{API_KEY}}
Authorization: Bearer {{JWT_TOKEN}}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"userType": "Administrator",
"preferredTransactionType": null,
"id": 12345,
"emailAddress": "bob_smith@somedomain.test",
"externalIdentity": "bob_smith@somedomain.test",
"userName": "bob_smith@somedomain.test",
"name": "Bob Smith",
"legalName": null,
"accountCode": null,
"systemCode": null,
"taxId": null,
"billingAddress": null,
"physicalAddress": null,
"isActive": true,
"isFiltered": false,
"emailOptIn": false,
"membershipGroups": [
{
"membershipGroupId": 1,
"name": "Administrator",
"description": "Has all permissions",
"roles": null,
"users": null
}
],
"membershipRoles": [
{
"membershipRoleId": 686,
"name": "AccountingForAnyLedgerType",
"description": "Allows a user to view and pay/receive any ledger type in Accounts Payable/Accounts Receiveable. Must be used in conjunction with Create Payments or Create Receivables. Must be used in conjunction with Full Remit or Remit Based Rules.",
"fxRoleCategoryId": null,
"users": null
}
],
"expiredDate": null
}
]

Retrieve user by ID (GET /v1/seadminusers/12345)

GET /v1/seadminusers/12345 HTTP/1.1
x-api-key: {{API_KEY}}
Authorization: Bearer {{JWT_TOKEN}}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
[
{
"userType": "Administrator",
"preferredTransactionType": null,
"id": 12345,
"emailAddress": "bob_smith@somedomain.test",
"externalIdentity": "bob_smith@somedomain.test",
"userName": "bob_smith@somedomain.test",
"name": "Bob Smith",
"legalName": null,
"accountCode": null,
"systemCode": null,
"taxId": null,
"billingAddress": null,
"physicalAddress": null,
"isActive": true,
"isFiltered": false,
"emailOptIn": false,
"membershipGroups": [
{
"membershipGroupId": 1,
"name": "Administrator",
"description": "Has all permissions",
"roles": null,
"users": null
}
],
"membershipRoles": [
{
"membershipRoleId": 686,
"name": "AccountingForAnyLedgerType",
"description": "Allows a user to view and pay/receive any ledger type in Accounts Payable/Accounts Receiveable. Must be used in conjunction with Create Payments or Create Receivables. Must be used in conjunction with Full Remit or Remit Based Rules.",
"fxRoleCategoryId": null,
"users": null
}
],
"expiredDate": null
}
]

Update a user's groups (PUT /v1/seadminusers/12345)

PUT /v1/seadminusers/43248 HTTP/1.1
x-api-key: {{API_KEY}}
Content-Type: application/json
Authorization: Bearer {{JWT_TOKEN}}

{
"userType": "Administrator",
"emailAddress": "bob_smith@somedomain.test",
"userName": "bob_smith@somedomain.test",
"name": "Bob Smith",
"membershipGroups": [
{
"membershipGroupId": 2
},
{
"membershipGroupId": 3
}
],
"membershipRoles": [
{
"membershipRoleId": 686
}
]
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"userType": "Administrator",
"preferredTransactionType": null,
"id": 43248,
"emailAddress": "bob_smith@somedomain.test",
"externalIdentity": "bob_smith@somedomain.test",
"userName": "bob_smith@somedomain.test",
"name": "Bob Smith",
"legalName": null,
"accountCode": null,
"systemCode": null,
"taxId": null,
"billingAddress": {
"addressLine1": "",
"addressLine2": "",
"city": "",
"phoneNumber": "",
"fax": "",
"region": null,
"zipCode": ""
},
"physicalAddress": {
"addressLine1": "",
"addressLine2": "",
"city": "",
"phoneNumber": "",
"fax": "",
"region": null,
"zipCode": ""
},
"isActive": true,
"isFiltered": false,
"emailOptIn": false,
"membershipGroups": [
{
"membershipGroupId": 2,
"name": "Alpha Dealer",
"description": "Alpha Dealer",
"roles": null,
"users": null
},
{
"membershipGroupId": 3,
"name": "Bravo Dealer",
"description": "Bravo Dealer",
"roles": null,
"users": null
}
],
"membershipRoles": [
{
"membershipRoleId": 686,
"name": "AccountingForAnyLedgerType",
"description": "Allows a user to view and pay/receive any ledger type in Accounts Payable/Accounts Receiveable. Must be used in conjunction with Create Payments or Create Receivables. Must be used in conjunction with Full Remit or Remit Based Rules.",
"fxRoleCategoryId": null,
"users": null
}
],
"expiredDate": null
}

Expire/Deactivate a user (PUT /v1/seadminusers/12345)

expiredDate is the date at which the user will no longer be active, in this example, no longer active after 2025-11-23. If the passed in date/time is earlier than the current time, the expiredDate will be stored as the current time. If the passed in date/time is in the future, that date will be stored, and the user will be deactivated at that time.

PUT /v1/seadminusers/43248 HTTP/1.1
x-api-key: {{API_KEY}}
Content-Type: application/json
Authorization: Bearer {{JWT_TOKEN}}

{
"userType": "Administrator",
"emailAddress": "bob_smith@somedomain.test",
"userName": "bob_smith@somedomain.test",
"name": "Bob Smith",
"expiredDate": "2025-01-01",
"membershipGroups": [
{
"membershipGroupId": 2
},
{
"membershipGroupId": 3
}
],
"membershipRoles": [
{
"membershipRoleId": 686
}
]
}

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
"userType": "Administrator",
"preferredTransactionType": null,
"id": 43248,
"emailAddress": "bob_smith@somedomain.test",
"externalIdentity": "bob_smith@somedomain.test",
"userName": "bob_smith@somedomain.test",
"name": "Bob Smith",
"legalName": null,
"accountCode": null,
"systemCode": null,
"taxId": null,
"billingAddress": {
"addressLine1": "",
"addressLine2": "",
"city": "",
"phoneNumber": "",
"fax": "",
"region": null,
"zipCode": ""
},
"physicalAddress": {
"addressLine1": "",
"addressLine2": "",
"city": "",
"phoneNumber": "",
"fax": "",
"region": null,
"zipCode": ""
},
"isActive": false,
"isFiltered": false,
"emailOptIn": false,
"membershipGroups": [
{
"membershipGroupId": 2,
"name": "Alpha Dealer",
"description": "Alpha Dealer",
"roles": null,
"users": null
},
{
"membershipGroupId": 3,
"name": "Bravo Dealer",
"description": "Bravo Dealer",
"roles": null,
"users": null
}
],
"membershipRoles": [
{
"membershipRoleId": 686,
"name": "AccountingForAnyLedgerType",
"description": "Allows a user to view and pay/receive any ledger type in Accounts Payable/Accounts Receiveable. Must be used in conjunction with Create Payments or Create Receivables. Must be used in conjunction with Full Remit or Remit Based Rules.",
"fxRoleCategoryId": null,
"users": null
}
],
"expiredDate": "2025-11-24T16:33:32"
}

ADMIN Users API

Terminology#

API Endpoints#

GET /v1/seadminusers#

POST /v1/seadminusers#

GET /v1/seadminusers/{userId}#

PUT /v1/seadminusers/{userId}#

Examples#

Create a new user (POST /v1/seadminusers)#

Search for Users by Email Address (GET /v1/seadminusers)#

Retrieve user by ID (GET /v1/seadminusers/12345)#

Update a user's groups (PUT /v1/seadminusers/12345)#

Expire/Deactivate a user (PUT /v1/seadminusers/12345)#