Skip to content
REST API Reference
/
/User

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

User

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

Operations

Get a list of users

Request

Returns a paginated list of users. Supports optional filters and sorting parameters to refine the results. Useful for displaying user information, managing users in FlexNet operations, or performing administrative tasks.

Query
userNamestring

Filter by user name

displayNamestring

Filter by display name

emailstring

Filter by user email

accountIdstring

Filter by account ID

accountNamestring

Filter by account name

accountTypestring

Filter by account type (HOME,PUBLISHER,CUSTOMER,SELF_REGISTERED,CHANNEL_PARTNER,UNKNOWN)

statusstring

Status of the user (active,inactive)

sort_bystring

Field to sort by (displayName,email,status)

sort_orderstring

Order to sort by (asc/desc)

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/users?userName=string&displayName=string&email=string&accountId=string&accountName=string&accountType=string&status=string&sort_by=string&sort_order=string&page=0&limit=0'

Responses

Get user list

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

Create a user

Request

Bodyapplication/jsonrequired

Mandatory fields: firstName, lastName, emailAddress, accountRoles [accountName, roles]

firstNamestringrequired

First Name of the user

Example: "John"
lastNamestringrequired

Last Name of the user

Example: "Doe"
displayNamestring

Display name of the user

Example: "John Doe"
emailAddressstring[ 0 .. 1000 ] charactersrequired

Email address of the user

Example: "johndoe@xyz.com"
phoneNumberstring

User’s phone number

Example: "989915487"
faxNumberstring

User’s fax number

Example: "01154785"
streetstring

Street portion of address

Example: "High Street"
citystring

City portion of address

Example: "New York"
statestring

State portion of address

Example: "The Empire State"
zipcodestring

Postal code of address

Example: "10118"
countrystring

Two-letter country code

Example: "US"
localestring

User’s locale

Example: "en_US"
portalLoginboolean

Whether the User requires portal login or not?

Example: true
userNamestring

Important: The user name must match the email address for the user. If canLogin is set to false, this field is ignored. if canLogin is set to true, this field is required.

Example: "johndoe@xyz.com"
statusstring

Flag to indicate if the user should be Active or Inactive, Status can be one of the following values: Active, Inactive

Example: "Active"
timezonestring

Provide time zone setting in the format: GMT#.#DST#. When a user is saved, this offset is converted to a time zone string and the time zone string is displayed when a user is retrieved.

Example: "GMT-6.0DST0"
sharedboolean

Is this a shared login among several users?

Example: false
accountRolesArray of objects(UserAccountRole)[ 1 .. 2147483647 ] itemsrequired

List of account associated with user. Set user's account and list of the user’s roles. User name and roles are required if the user can log in

accountRoles[].​accountNamestringrequired

Account Name [unique identifier of Account - short name] which needs to be linked to User

Example: "123456"
accountRoles[].​expiryDatestring

Expiry date of the user in YYYY-MM-DD format. Expiry date should be provided when canLogin flag is true. It is the date when user is no longer linked to the account. If included, the value cannot be null. If not included, the user's access to the account will not expire.

Example: "2025-12-30"
accountRoles[].​rolesArray of strings[ 1 .. 2147483647 ] itemsrequired

List of roles.

Example: ["USER","ADMIN"]
attributesArray of objects(Attribute)

List of user custom attributes. Note that mandatory custom attributes must be included in this list

optInboolean

Whether the User should opt to receive email notifications

Example: false
canLoginboolean

Indicates whether created user can login to portal or not. If canLogin is false, the user is treated as a contact.

Example: true
curl -i -X POST \
  https://fnoapi.redocly.app/_mock/apis/rest/user-accounts/user-account-service/v1/users \
  -H 'Content-Type: application/json' \
  -d '{
    "firstName": "John",
    "lastName": "Doe",
    "displayName": "John Doe",
    "emailAddress": "johndoe@xyz.com",
    "phoneNumber": "989915487",
    "faxNumber": "01154785",
    "street": "High Street",
    "city": "New York",
    "state": "The Empire State",
    "zipcode": "10118",
    "country": "US",
    "locale": "en_US",
    "portalLogin": true,
    "userName": "johndoe@xyz.com",
    "status": "Active",
    "timezone": "GMT-6.0DST0",
    "shared": false,
    "accountRoles": [
      {
        "accountName": "123456",
        "expiryDate": "2025-12-30",
        "roles": [
          "USER",
          "ADMIN"
        ]
      }
    ],
    "attributes": [
      {
        "name": "REGION",
        "value": "EMEA"
      }
    ],
    "optIn": false,
    "canLogin": true
  }'

Responses

Created a user successfully

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

Get a user

Request

Path
userNamestringrequired

User name of the user

curl -i -X GET \
  'https://fnoapi.redocly.app/_mock/apis/rest/user-accounts/user-account-service/v1/users/{userName}'

Responses

Get user

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