Skip to content
REST API Reference
/
/Account

User and Account API (Beta) (1.0.0_Beta)

API documentation for User and Account service

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://flexera1000-uat.flexnetoperations.com/users-accounts-api/

Account

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

Operations

Create an account

Request

Bodyapplication/jsonrequired

Mandatory fields: accountId, name

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
accountTypestring

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/account \
  -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"
}

Get accounts

Request

Query
accountIdstring

Filter Accounts by Account ID

accountNamestring

Filter Accounts by Account Name

accountTypeArray of strings

Filter Accounts by Account type

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"
}

User

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

Operations