Skip to content
REST API Reference/
User and Accounts REST AP...
/
/
Get a list of accounts

Introduction to the User and Account REST API (1.0.0_Beta)

The User and Account REST API provides endpoints for managing users and accounts within your system. It supports essential operations such as creating, retrieving, updating, and deleting both user and account records.

The User and Account REST API is currently in its beta version and remains under active development. As such, it is not yet fully optimized, and may undergo significant changes or enhancements. Revenera strongly advises against using this API in production environments.

Download OpenAPI description
user-account-service.json
user-account-service.yaml
Languages
Servers
Mock server
https://fnoapi.redocly.app/_mock/apis/rest/user-accounts/user-account-service
Generated server url
https://YourSiteID-fno-uat.flexnetoperations.com/users-accounts-api

Account

API for managing account-related operations such as creation, retrieval, update, and deletion.

Operations

Get a list of accounts

Request

Query
accountIdstring

Filter accounts by account ID

accountNamestring

Filter accounts by account name

accountTypeArray of strings

Filter accounts by account type (CUSTOMER, PUBLISHER, CHANNEL_PARTNER, SELF_REGISTERED)

Default ["CUSTOMER"]
rootAccountOnlyboolean

Filter root accounts only

Default false
pageinteger(int32)

Requested page number

limitinteger(int32)

Number of records per page

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/user-accounts/user-account-service/v1/accounts?accountId=string&accountName=string&accountType=CUSTOMER&rootAccountOnly=false&page=0&limit=0'

Responses

Get Accounts

Bodyapplication/json
statusstring
Response
application/json
{
  "status": "string"
}

Create an account

Request

Bodyapplication/jsonrequired

Mandatory fields: accountId, name, accountType

accountIdstringrequired

Unique identifier of the account (short account name)

Example: "12345"
namestringrequired

Display name of the account (full account name)

Example: "Flexera Software LLC"
descriptionstring

Description of the account

Example: "Flexera Software LLC - Main Office"
address1string

First line of account's address

Example: "123 Flexera St"
address2string

Second line of account's address

Example: "Suite 100"
citystring

City portion of account's address

Example: "Chicago"
statestring

State portion of account's address

Example: "IL"
zipcodestring

Zip/Postal code of the account's address

Example: "60601"
countrystring

Two-letter country code

Example: "US"
regionstring

Region in which this account's address exists

Example: "North America"
visibleboolean

Applicable to CUSTOMER and CHANNEL_PARTNER accounts, visible determines whether or not an account unrelated to this account can see the name of this account when it is in a channel partner tier of an entitlement, line item, or device. If visible is false, this account will appear as Name Withheld to unrelated accounts. Default: true

Example: true
accountTypestringrequired

Defines the account type. Valid values: CUSTOMER, PUBLISHER, CHANNEL_PARTNER Default: CUSTOMER. (Using REST API, a new account cannot be created with an accountType of SELF_REGISTERED.)

Example: "CUSTOMER"
attributesArray of objects(Attribute)

List of custom attributes attached to this account. Note that mandatory custom attributes must be included in this list.

curl -i -X POST \
  https://fnoapi.redocly.app/_mock/apis/rest/user-accounts/user-account-service/v1/accounts \
  -H 'Content-Type: application/json' \
  -d '{
    "accountId": "12345",
    "name": "Flexera Software LLC",
    "description": "Flexera Software LLC - Main Office",
    "address1": "123 Flexera St",
    "address2": "Suite 100",
    "city": "Chicago",
    "state": "IL",
    "zipcode": "60601",
    "country": "US",
    "region": "North America",
    "visible": true,
    "accountType": "CUSTOMER",
    "attributes": [
      {
        "name": "REGION",
        "value": "EMEA"
      }
    ]
  }'

Responses

Created an account successfully

Bodyapplication/json
statusstring
Response
application/json
{
  "status": "string"
}

User

API for managing user-related operations such as creation, retrieval, update, and deletion.

Operations