API docs by Redocly

Aptic API Gateway - Users (v1.0)

Download OpenAPI specification:

Aptic AB: api@aptic.net URL: https://www.aptic.net Terms of Service

Users related API for Aptic solutions

CurrentUser

Get current user details

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "uniqueId": "string",
  • "partyReferenceCode": "string",
  • "email": "string",
  • "fullName": "string",
  • "userRole": 1,
  • "languageCode": "string",
  • "countryFormat": "string",
  • "cultureCode": "string",
  • "systemCurrencyCode": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "stateCode": "string",
  • "zipCode": "string",
  • "countryCode": "string",
  • "phoneNumber": "string",
  • "cellularPhoneNumber": "string",
  • "pbxPhoneNumber": "string",
  • "employmentNumber": "string",
  • "department": "string",
  • "photoImageType": "string",
  • "photoImage": "string",
  • "accessGroups": [
    ],
  • "accessCodes": [
    ],
  • "clientRestriction": [
    ],
  • "links": [
    ]
}

Updates current user

Authorizations:
(oauth2apikey)
Request Body schema:
password
string or null

User's new password if you want to change it, otherwise null.

currentPassword
string or null

User's current password. Required if you want to change password, otherwise null.

languageCode
string or null

Preferred language code of the user. Two caracter ISO abbrevation, like 'en', 'sv', 'no', etc.

countryFormat
string or null

Preferred country code for formatting data fields for the user. Two caracter ISO abbrevation, like 'SE', 'NO', 'DE', etc.

cultureCode
string or null

Preferred language and country code for formatting data fields for the user. ISO abbrevations, like 'sv-SE', 'sv-FI', 'en-GB', etc.

Responses

Request samples

Content type
{
  • "password": "string",
  • "currentPassword": "string",
  • "languageCode": "string",
  • "countryFormat": "string",
  • "cultureCode": "string"
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get current user's user group memberships

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Get current user's user assignments

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Get current user setting contexts

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "contexts": [
    ]
}

Get current user setting groups by context

Authorizations:
(oauth2apikey)
path Parameters
context
required
string

User settings context

Responses

Response samples

Content type
{ }

Get current user settings by context and group

Authorizations:
(oauth2apikey)
path Parameters
context
required
string

User settings context

group
required
string

User settings group within the context

Responses

Response samples

Content type
{ }

Stores current user setting by context

Authorizations:
(oauth2apikey)
path Parameters
context
required
string

User settings context

group
required
string

User settings group within the context

Request Body schema:

One or more settings to update in the group

any

Responses

Request samples

Content type
null

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Gets metadata for the settings by context and group

Authorizations:
(oauth2apikey)
path Parameters
context
required
string

User settings context

group
required
string

User settings group within the context

Responses

Response samples

Content type
{ }

Get current user list of most recent used entites (MRU list)

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "items": [
    ]
}

Adds new entity to MRU list

Authorizations:
(oauth2apikey)
Request Body schema:
guid
string or null

The unique Guid used to access the specific

type
integer <int32>

Type of item

1 = Debt collection case

2 = Client

3 = Debtor

4 = 3rd party

5 = Invoice

6 = Account

7 = Customer

8 = Purchase

9 = Object

Responses

Request samples

Content type
{
  • "guid": "string",
  • "type": 0
}

Response samples

Content type
{
  • "items": [
    ]
}

Deletes the whole MRU list

Authorizations:
(oauth2apikey)
query Parameters
entityGuid
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes entity from MRU list

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get favorites using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Adds new entity to favorite list

Authorizations:
(oauth2apikey)
Request Body schema:

Favorite entity to add

type
string or null

Type of item

0 = UI specific URL 1 = Debt collection case

2 = Client

3 = Debtor

4 = 3rd party

5 = Invoice

6 = Account

7 = Customer

8 = Purchase

9 = Object

guid
string or null

The unique Guid used to access the specific target when Type > 0

url
string or null

Custom URL used with Type = 0

subType
string or null

Custom sub type used with Type = 0

primaryDescription
string or null

Primary description of the item when Type = 0

secondaryDescription
string or null

Optional secondary description when Type = 0

Responses

Request samples

Content type
{
  • "type": "string",
  • "guid": "string",
  • "url": "string",
  • "subType": "string",
  • "primaryDescription": "string",
  • "secondaryDescription": "string"
}

Response samples

Content type
{
  • "itemGuid": "string",
  • "type": "string",
  • "guid": "string",
  • "primaryDescription": "string",
  • "secondaryDescription": "string"
}

Clears the whole favorite list

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Updates an entity in the favourite list

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

The unique GUID of the favorite entity

Request Body schema:

Favorite entity data to update

position
integer or null <int32>

Change position of the favorite item in the default list

Responses

Request samples

Content type
{
  • "position": 0
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Removes an entity from the favorite list

Authorizations:
(oauth2apikey)
path Parameters
guid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }

Users

Get users using filters

Authorizations:
(oauth2apikey)
query Parameters
$filter
string

Filter conditions specified in a simplified OData format

$skip
integer <int32>

List offset when paginating (default 0)

$top
integer <int32>

Maximum size of result (default 25, max 100)

$orderby
string

Sorting conditions E.g. "fullname desc"

Responses

Response samples

Content type
{
  • "count": 0,
  • "skip": 0,
  • "total": 0,
  • "value": [
    ]
}

Creates a new user

Authorizations:
(oauth2apikey)
Request Body schema:
partyReferenceCode
string or null

Party referende of the party the user belongs to. Required field.

userCode
string or null

User code. Must be unique. Can be used as identifier when logging in. Can be omitted.

email
string or null

User's email address. Can be used as identifier when logging in. Required field.

password
string or null

User's password. Required field unless ClientId and ClientSecret are used.

clientId
string or null

Client id if the user is an API user. Can be omitted, but needs to be Guid, if specified.

clientSecret
string or null

Client secret if the user is an API user. Must be a unique identifier. Can be omitted if UserCode/Password is used.

apiUser
boolean or null

Set to true if the user is intended for API integrations only

fullName
string or null

User's full name. Required field.

disabled
boolean or null

Set to true if the user is disabled and will not be able to login.

userRole
integer <int32> (UserRoleType)
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14

User role type

1 = Server

2 = Solicitor, Administrator

3 = Solicitor User

4 = Solicitor, Sales

5 = Solicitor, Other

6 = Creditor, C.E.O

7 = Creditor, Economy

8 = Creditor, Invoice receiver

9 = Creditor, Other

10 = Rentalobject, Administrator

11 = Creditor, Primary contact

12 = Creditor, Report receiver

13 = Creditor, Trust accounting receiver

14 = Field collector

mfaType
integer or null <int32>

Specifies type of Multi Factor Authentication to use.

0 = No MFA

1 = MFA using Authenticator App

2 = MFA using email

3 = MFA using SMS/text message

languageCode
string or null

Preferred language code of the user. Two caracter ISO abbrevation, like 'en', 'sv', 'no', etc.

countryFormat
string or null

Preferred country code for formatting data fields for the user. Two caracter ISO abbrevation, like 'SE', 'NO', 'DE', etc.

street
string or null

Street address for the user.

houseNo
string or null

House number for the user.

houseNoExtension
string or null

House number extension for the user.

city
string or null

City in the user's address.

stateCode
string or null

State code in the user's address.

zipCode
string or null

zip code in the user's address.

countryCode
string or null

ISO Country code in the user's address.

phoneNumber
string or null

User's phone number.

cellularPhoneNumber
string or null

User's mobile/cellular phone number.

pbxPhoneNumber
string or null

User's switchboard phone number.

employmentNumber
string or null

User's employment number.

department
string or null

User's department (freetext).

photoImageType
string or null

User's profile photo image type, e.g. 'image/jpeg'

photoImage
string or null

User's profile photo image base64 encoded

existingUserUniqueId
string or null

Specify an existing unique identifier (GUID) for the new user. If omitted, a new GUI will be generated.

accessGroups
Array of strings or null

Array of access groups/roles the user belongs to

Array of objects or null (ClientRestriction)

Array of clients the user have access to

Responses

Request samples

Content type
{
  • "partyReferenceCode": "string",
  • "userCode": "string",
  • "email": "string",
  • "password": "string",
  • "clientId": "string",
  • "clientSecret": "string",
  • "apiUser": true,
  • "fullName": "string",
  • "disabled": true,
  • "userRole": 1,
  • "mfaType": 0,
  • "languageCode": "string",
  • "countryFormat": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "stateCode": "string",
  • "zipCode": "string",
  • "countryCode": "string",
  • "phoneNumber": "string",
  • "cellularPhoneNumber": "string",
  • "pbxPhoneNumber": "string",
  • "employmentNumber": "string",
  • "department": "string",
  • "photoImageType": "string",
  • "photoImage": "string",
  • "existingUserUniqueId": "string",
  • "accessGroups": [
    ],
  • "clientRestriction": [
    ]
}

Response samples

Content type
{
  • "uniqueId": "string",
  • "partyReferenceCode": "string",
  • "userCode": "string",
  • "email": "string",
  • "fullName": "string",
  • "disabled": true,
  • "apiUser": true,
  • "userRole": 1,
  • "languageCode": "string",
  • "countryFormat": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "stateCode": "string",
  • "zipCode": "string",
  • "countryCode": "string",
  • "phoneNumber": "string",
  • "cellularPhoneNumber": "string",
  • "pbxPhoneNumber": "string",
  • "employmentNumber": "string",
  • "department": "string",
  • "photoImageType": "string",
  • "photoImage": "string",
  • "accessGroups": [
    ],
  • "clientRestriction": [
    ],
  • "links": [
    ]
}

Get user details based on the unique GUID

Authorizations:
(oauth2apikey)
path Parameters
userGuid
required
string

The unique GUID of the user

Responses

Response samples

Content type
{
  • "uniqueId": "string",
  • "partyReferenceCode": "string",
  • "userCode": "string",
  • "email": "string",
  • "fullName": "string",
  • "disabled": true,
  • "apiUser": true,
  • "userRole": 1,
  • "languageCode": "string",
  • "countryFormat": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "stateCode": "string",
  • "zipCode": "string",
  • "countryCode": "string",
  • "phoneNumber": "string",
  • "cellularPhoneNumber": "string",
  • "pbxPhoneNumber": "string",
  • "employmentNumber": "string",
  • "department": "string",
  • "photoImageType": "string",
  • "photoImage": "string",
  • "accessGroups": [
    ],
  • "clientRestriction": [
    ],
  • "links": [
    ]
}

Updates a user

Authorizations:
(oauth2apikey)
path Parameters
userGuid
required
string
Request Body schema:
email
string or null

User's email address. Can be used as identifier when logging in.

password
string or null

User's password. Required field.

fullName
string or null

User's full name.

disabled
boolean or null

Set to true if the user is disabled and will not be able to login.

userRole
integer <int32> (UserRoleType)
Enum: 1 2 3 4 5 6 7 8 9 10 11 12 13 14

User role type

1 = Server

2 = Solicitor, Administrator

3 = Solicitor User

4 = Solicitor, Sales

5 = Solicitor, Other

6 = Creditor, C.E.O

7 = Creditor, Economy

8 = Creditor, Invoice receiver

9 = Creditor, Other

10 = Rentalobject, Administrator

11 = Creditor, Primary contact

12 = Creditor, Report receiver

13 = Creditor, Trust accounting receiver

14 = Field collector

languageCode
string or null

Preferred language code of the user. Two caracter ISO abbrevation, like 'en', 'sv', 'no', etc.

countryFormat
string or null

Preferred country code for formatting data fields for the user. Two caracter ISO abbrevation, like 'SE', 'NO', 'DE', etc.

street
string or null

Street address for the user.

houseNo
string or null

House number for the user.

houseNoExtension
string or null

House number extension for the user.

city
string or null

City in the user's address.

stateCode
string or null

State code in the user's address.

zipCode
string or null

zip code in the user's address.

countryCode
string or null

ISO Country code in the user's address.

phoneNumber
string or null

User's phone number.

cellularPhoneNumber
string or null

User's mobile/cellular phone number.

pbxPhoneNumber
string or null

User's switchboard phone number.

employmentNumber
string or null

User's employment number.

department
string or null

User's department (freetext).

photoImageType
string or null

User's profile photo image type, e.g. 'image/jpeg'

photoImage
string or null

User's profile photo image base64 encoded

accessGroups
Array of strings or null

Array of access groups/roles the user belongs to

Array of objects or null (ClientRestriction)

Array of clients the user have access to

Responses

Request samples

Content type
{
  • "email": "string",
  • "password": "string",
  • "fullName": "string",
  • "disabled": true,
  • "userRole": 1,
  • "languageCode": "string",
  • "countryFormat": "string",
  • "street": "string",
  • "houseNo": "string",
  • "houseNoExtension": "string",
  • "city": "string",
  • "stateCode": "string",
  • "zipCode": "string",
  • "countryCode": "string",
  • "phoneNumber": "string",
  • "cellularPhoneNumber": "string",
  • "pbxPhoneNumber": "string",
  • "employmentNumber": "string",
  • "department": "string",
  • "photoImageType": "string",
  • "photoImage": "string",
  • "accessGroups": [
    ],
  • "clientRestriction": [
    ]
}

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Deletes a user

Authorizations:
(oauth2apikey)
path Parameters
userGuid
required
string

Responses

Response samples

Content type
{
  • "type": "string",
  • "title": "string",
  • "status": 0,
  • "detail": "string",
  • "instance": "string",
  • "property1": null,
  • "property2": null
}

Get limited user information based on the unique GUID. Requires less access rights that a full get.

Authorizations:
(oauth2apikey)
path Parameters
userGuid
required
string

The unique GUID of the user

Responses

Response samples

Content type
{
  • "uniqueId": "string",
  • "partyReferenceCode": "string",
  • "email": "string",
  • "fullName": "string",
  • "department": "string",
  • "photoImageType": "string",
  • "photoImage": "string"
}

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
userGuid
required
string

User unique id

serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Invokes a custom action based on a service definition.

Execute custom service definition in CLVR with possibility to pass in JSON into definition.

Authorizations:
(oauth2apikey)
path Parameters
serviceDefinition
required
string

The invoke service definition request.

query Parameters
async
boolean

Specify if custom action should be performed asynchronously

Request Body schema:

JSON body

any

Responses

Request samples

Content type
{
  • "name1": "string",
  • "name2": false,
  • "name3": {
    }
}

Response samples

Content type
{ }

Make a ping request to see that the service is up and running.

This operation enables to check if service is available. The service will return code 200 and an empty json object.

Authorizations:
(oauth2apikey)

Responses

Response samples

Content type
{ }