Skip to main content
API docs by Redocly

Users (1.0)

Download OpenAPI specification:Download

License: Nexway License Version 1.0

API to manage users identity and access management. It brings together the management and modification of users, groups and roles.

Users

Get item

Retrieved one user from a customer

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "locale": "string",
  • "inactive": true,
  • "token": "string",
  • "userName": "string",
  • "password": "string",
  • "clientId": "string",
  • "secretKeys": [
    ],
  • "roleIds": [
    ],
  • "metaRoleIds": [
    ],
  • "authorizedCustomerIds": [
    ],
  • "emails": [
    ],
  • "preferences": {
    },
  • "provider": {
    }
}

Update a user

Update a user from a customer.

Authorizations:
Bearer
path Parameters
id
required
string
Request Body schema: application/json
required
customerId
string
email
required
string [ 6 .. 150 ] characters

Email

firstName
required
string [ 1 .. 50 ] characters

First name

lastName
required
string [ 1 .. 50 ] characters

Last name

userName
required
string [ 1 .. 50 ] characters

Name

status
required
string
Enum: "ENABLED" "DISABLED"

Status

authorizedCustomerIds
Array of strings unique

Customer Identifiers this user has rights on

Responses

Request samples

Content type
application/json
{
  • "customerId": "string",
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "userName": "string",
  • "status": "ENABLED",
  • "authorizedCustomerIds": [
    ]
}

Delete a user

Delete a user from a customer.

Authorizations:
Bearer
path Parameters
id
required
string

Responses

Get items

Retrieved all users from a customer.

Authorizations:
Bearer
query Parameters
required
object (Pageable)
predicate
required
object
target
string

Return selected fields only (multiple occurrences allowed for selecting multiple fields)

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Create a user

Create a user from a customer.

Authorizations:
Bearer
Request Body schema: application/json
required
id
string
Deprecated
customerId
string
createDate
string <date-time>
Deprecated
updateDate
string <date-time>
Deprecated
modelVersion
string
Deprecated
dbVersion
integer <int64>
lastUpdateReason
string
originalId
string
status
required
string
Enum: "ENABLED" "DISABLED"

Status

email
required
string [ 6 .. 150 ] characters

Email

firstName
required
string [ 1 .. 50 ] characters

First name

lastName
required
string [ 1 .. 50 ] characters

Last name

userName
required
string [ 1 .. 50 ] characters

Name

password
required
string [ 8 .. 50 ] characters

Password

token
string

Token used for reset the password

Array of objects (Email)

List of emails sent to the user

Array of objects (AuthorizedCustomer)

List of authorized customer

object

Preferences

authorizedCustomerIds
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "customerId": "string",
  • "createDate": "2019-08-24T14:15:22Z",
  • "updateDate": "2019-08-24T14:15:22Z",
  • "modelVersion": "string",
  • "dbVersion": 0,
  • "lastUpdateReason": "string",
  • "originalId": "string",
  • "status": "ENABLED",
  • "email": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "userName": "string",
  • "password": "stringst",
  • "token": "string",
  • "emails": [
    ],
  • "authorizedCustomers": [
    ],
  • "preferences": {
    },
  • "authorizedCustomerIds": [
    ]
}

Response samples

Content type
application/json
{ }

Get recap quantities for a given field

Get a list of recap entries

Authorizations:
Bearer
query Parameters
target
required
string

Return selected fields only (multiple occurrences allowed for selecting multiple fields)

required
object (Pageable)
predicate
required
object

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "last": true,
  • "totalItems": 0,
  • "totalPages": 0,
  • "size": 0,
  • "number": 0
}

Public

Reset a password

Reset a password from a user.

Authorizations:
None
path Parameters
realm
required
string
token
required
string
Request Body schema: application/json
required
password
required
string

Password related to a user.

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Trigger the lost password actions

Trigger the lost password actions.

Authorizations:
None
path Parameters
realm
required
string
Request Body schema: application/json
required
email
required
string [ 6 .. 150 ] characters

User email

Responses

Request samples

Content type
application/json
{
  • "email": "string"
}

Check validity of password token

Check validity of password token.

Authorizations:
None
path Parameters
realm
required
string
token
required
string

Responses