Documentation Powered by ReDoc

onway director API (4.7.0)

Download OpenAPI specification:Download

Support: support@onway.ch URL: https://www.onway.ch

Introduction

Response schema

Each response of the API is structured according to the same schema. The status property displays the returned HTTP status, while the links property provides useful URI templates (RFC 6570) for navigation. The answer itself is provided via the content property. If an error occurs, the problem property is set and provides useful information about the error.

Problem schema

A problem has four different properties. The type property specifies the type of the problem. In addition, the title property provides a human-readable title and the optional message property contains the error message itself. If the problem is of the type constraint-violations, the optional violations property provides more details about the problem. Such a violation object supplies the two fields field and message.

Response codes

The API uses only the following status codes:

  • The 200 (OK) status code indicates that the request has succeeded. The payload sent in a 200 response depends on the request method.

  • The 400 (Bad Request) status code indicates that the server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).

  • The 401 (Unauthorized) status code indicates that the request has not been applied because it lacks valid authentication credentials for the target resource.

  • The 403 (Forbidden) status code indicates that the server understood the request but refuses to authorize it.

  • 404 The 404 (Not Found) status code indicates that the origin server did not find a current representation for the target resource or is not willing to disclose that one exists. A 404 status code does not indicate whether this lack of representation is temporary or permanent.

  • The 500 (Internal Server Error) status code indicates that the server encountered an unexpected condition that prevented it from fulfilling the request.

Authentication

To use the API, a security token must always be sent in the X-AUTH-TOKEN header. This token can be obtained via the authentication API.

Endpoints

All public endpoints start with the prefix /api. These endpoints are documented and stable.

All other endpoints are internal and breaking changes may be introduced at any time.

Authentication

Authentication API to login and logout.

Login

Request Body schema: application/json
password
required
string
userDirectoryId
required
integer <int64>

ID of the user directory. You can find the ID under: Sponsoring Portal / Administration / User Directories.

username
required
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "userDirectoryId": 0,
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Logout

Responses

Response samples

Content type
application/json
{
  • "content": { },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Application Version

Get application version

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Input Templates

Provides access to the input templates.

Get all input templates

query Parameters
customerKey
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Customers

Provides access to the customers.

Get all customers

Returns all customers you have access to.

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Get a specific customer

path Parameters
key
required
string

key of the customer

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Tags

Get all tags of a customer

path Parameters
customerKey
required
string

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Network Access Accounts

Allows to create, read, update and delete Network Access Accounts.

Get network access accounts

query Parameters
size
integer <int32>

Number of accounts to fetch. The default value is 25

customerKey
required
string
type
required
string
Enum: "PEAP" "IPSK" "MAB" "BYOD_USER" "BYOD_DEVICE" "PEAP_DEVICE"
seekIdentifier.username
string

Username used for pagination. If you for example fetch 10 accounts with a request, you can send the same request again with the username, naGroupId and id of the last account as seek identifier, to fetch the next 10 accounts.

seekIdentifier.naGroupId
integer <int64>

Network access group id used for pagination. Required if seekIdentifier.username is set.

seekIdentifier.id
integer <int64>

Network access account id used for pagination. Required if seekIdentifier.username is set.

seekDirection
string
Enum: "FORWARD" "BACKWARD"
naGroupIds
Array of integers <int64> unique
tagIds
Array of integers <int64> unique
tagOperator
string
Enum: "OR" "AND"

Specifies if the account must have all tag ids (AND) or any (OR).

query
string

Search query applied to the name and comment field. Multiple values can be specified separated by spaces.

validityType
string
Enum: "CUSTOM" "EXPIRED" "UNLIMITED" "VALID_NOW" "VALID_IN_FUTURE"
customValidity.validFrom
string <date-time>

Required if validityType is CUSTOM

customValidity.validTo
string <date-time>

Required if validityType is CUSTOM

stateFilterType
string
Enum: "NORMAL" "DELETED" "ALL"

Whether only active, deleted or all accounts should be included.

onlineStatusFilterType
string
Enum: "ALL" "UNKNOWN" "ONLINE" "OFFLINE"

Whether network access accounts with certain online status should be included.

lastSeenFilterType
string
Enum: "NEVER_SEEN" "NOT_SEEN_SINCE_DURATION" "NOT_SEEN_SINCE_DATE" "SEEN_SINCE_DURATION" "SEEN_SINCE_DATE"

Allows to filter accounts/devices by the lastSeenAt field.

lastSeenDate
string <date-time>

This field is required if lastSeenFilterType has one of the following values:

  • NOT_SEEN_SINCE_DATE: Only accounts that have not been seen since this date will be returned.
  • SEEN_SINCE_DATE: Only accounts that are online or have been online since this date will be returned.
lastSeenDuration
string <ISO 8601 duration>
Example: lastSeenDuration=PT10H

This field is required if lastSeenFilterType has one of the following values:

  • NOT_SEEN_SINCE_DURATION: Only accounts that have not been seen for this duration will be returned.
  • SEEN_SINCE_DURATION: Only accounts that are online or were last online within this duration will be returned.

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Create a network access account

path Parameters
customerKey
required
string
Request Body schema: application/json
comment
string
Array of objects (CustomFieldValueDTO)
naGroupId
required
integer <int64>
password
string

Required to create a PEAP user or iPSK device. Optional when updating.

tagIds
Array of integers <int64> unique
type
required
string
Enum: "PEAP" "IPSK" "MAB"
username
required
string
object (AccountValidityDTO)

Validity period of the account.

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "customFieldValues": [
    ],
  • "naGroupId": 0,
  • "password": "string",
  • "tagIds": [
    ],
  • "type": "PEAP",
  • "username": "string",
  • "validity": {
    }
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Mark a network access account as deleted

An account that is marked as deleted can no longer login. The account is deleted after a retention period that can be configured in the settings.

path Parameters
customerKey
required
string
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Get a specific network access account

path Parameters
customerKey
required
string
id
required
integer <int64>

Responses

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Update a network access account

path Parameters
customerKey
required
string
Request Body schema: application/json
comment
string
Array of objects (CustomFieldValueDTO)
id
required
integer <int64>
naGroupId
required
integer <int64>
password
string

Required to create a PEAP user or iPSK device. Optional when updating.

tagIds
Array of integers <int64> unique
type
required
string
Enum: "PEAP" "IPSK" "MAB"
username
required
string
object (AccountValidityDTO)

Validity period of the account.

Responses

Request samples

Content type
application/json
{
  • "comment": "string",
  • "customFieldValues": [
    ],
  • "id": 0,
  • "naGroupId": 0,
  • "password": "string",
  • "tagIds": [
    ],
  • "type": "PEAP",
  • "username": "string",
  • "validity": {
    }
}

Response samples

Content type
application/json
{
  • "content": {
    },
  • "links": { },
  • "reason": "OK",
  • "status": 200
}

Network Access Groups

Provides access to the Network Access Groups.

Get network access groups

query Parameters
customerKey
required
string
type
required
string
Enum: "PEAP" "IPSK" "MAB" "BYOD"

Responses

Response samples

Content type
application/json
{
  • "content": [
    ],
  • "links": { },
  • "reason": "OK",
  • "status": 200
}