Documentation Powered by ReDoc

(1.0.0)

Download OpenAPI specification:Download

Welle Proxy OpenAPI Documentation

IC Governor (Welle) is the next generation Access Review engine, which helps support enterprise IT security and regulatory compliance. Unlike traditional Identity Governance products, IC Governor (Welle) is light-weight in architecture. It has a responsive user interface and speedy in back-end remediation. You can manage the identity life-cycle in your organization in a secure and convenient portal.

Mobile

Login

User login by scanning mobile QR

Request Body schema: application/json

A JSON object containing request body information

hashCode
string
deviceId
string
location
string
version
string

Responses

Request samples

Content type
application/json
{
  • "hashCode": "nxbczftzazpdjojz",
  • "deviceId": "94703EC2-0AAD-xxxxx-xxxxx-xxxxxxxxxx",
  • "location": "Singapore",
  • "version": "1.3"
}

Response samples

Content type
application/json
{ }

Register

Register a new device for a user

Request Body schema: application/json

A JSON object containing request body information

notificationToken
string
nounce
string
deviceId
string
location
string
phoneType
string
version
string
hashCode
string

Responses

Request samples

Content type
application/json
{
  • "notificationToken": "cwZBvGYYQG2mhZl73C06k5:APA91bGdOuVpcBwp7vfSRbb2YpvnzdAyAfJQBfecKQZMP-JLgYAkD3gg_kTuSqQyCyjzgnjuX7JiIbWDl11wlG7dQBVW049sxnM-G8XbFd_xxxxx_om1KBqwMf-xxxxx-VxTzxd5XKKd",
  • "nounce": "YqdrlsUyQupB+ZUqHXDMadgz0/otBmOoyYOo9QVB+fCqHM6TWnSUg7U88IIYQ5nZ0ZXEIlLaHCYz9xojHRxagw==",
  • "deviceId": "94703EC2-0AAD-xxxx-xxxx-xxxxxxxxxxxx",
  • "location": "Singapore",
  • "phoneType": "iOS/iPhone 7 Plus",
  • "version": "1.0.0",
  • "hashCode": "jomjffxakhalirle"
}

Response samples

Content type
application/json
{ }

Users

Get the user information based on linked device ID

Request Body schema: application/json

A JSON object containing request body information

deviceId
string
location
string
version
string

Responses

Request samples

Content type
application/json
{
  • "deviceId": "94703EC2-0AAD-xxxxx-xxxxx-xxxxxxxxxx",
  • "location": "Singapore",
  • "version": "1.2"
}

Response samples

Content type
application/json
{
  • "givenName": "Max Lee",
  • "roles": "manager",
  • "session-jwt": "{session-jwt}",
  • "userName": "maxl"
}

Request Approval

Approval

Get a request that requires approval

path Parameters
request-id
required
string
Example: 1276

request-id using taskId from Request Approval - Approval Listing API

header Parameters
Authorization
required
string
Example: Bearer {session-jwt}
deviceId
required
string
Example: 94703EC2-0AAD-xxxxx-xxxxx-xxxxxxxxxx

Responses

Response samples

Content type
application/json
{
  • "suspensionState": 1,
  • "cachedElContext": null,
  • "parentTaskId": null,
  • "dueDate": null,
  • "_rev": "1",
  • "taskLocalVariables": { },
  • "description": null,
  • "activityInstanceVariables": { },
  • "delegationState": null,
  • "delegationStateString": null,
  • "eventName": null,
  • "revisionNext": 2,
  • "formProperties": [
    ],
  • "owner": null,
  • "processDefinitionId": "oneLevelAccessRequest:4:838",
  • "processInstanceId": "1027",
  • "variables": {
    },
  • "priority": 50,
  • "suspended": false,
  • "executionId": "1027",
  • "taskDefinitionKey": "managerApproval",
  • "candidates": {
    },
  • "deleted": false,
  • "createTime": "2020-07-24T11:42:30.000+08:00",
  • "name": "User Access Request Approval",
  • "tenantId": "",
  • "_id": "1083",
  • "assignee": null,
  • "category": null,
  • "processVariables": { },
  • "queryVariables": null
}

Approval listing

Get a list of requests that require approval by user

query Parameters
userName
required
string
Example: userName=maxl
header Parameters
Authorization
required
string
Example: Bearer {session-jwt}
deviceId
required
string
Example: 94703EC2-0AAD-xxxxx-xxxxx-xxxxxxxxxx

Responses

Response samples

Content type
application/json
{
  • "data": [
    ]
}

Approval decision

Approve a request can only be cancelled when it is still In Progress.

path Parameters
request-id
required
string
Example: 1050

request-id using taskId from Request Approval - Approval Listing API

header Parameters
Authorization
required
string
Example: Bearer {session-jwt}
deviceId
required
string
Example: 94703EC2-0AAD-xxxxx-xxxxx-xxxxxxxxxx
Request Body schema: application/json

A JSON object containing request body information

action
string
decision
string
comment
string

Responses

Request samples

Content type
application/json
Example
Action approve - accept
Action approve - accept
Action approve - reject
{
  • "action": "approve",
  • "decision": "accept",
  • "comment": ""
}

Response samples

Content type
application/json
{
  • "result": true
}

Request Tracking

Tracking list

Get a list of requests that user is involved, either as a requester or approver

query Parameters
userName
required
string
Example: userName=maxl
header Parameters
Authorization
required
string
Example: Bearer {session-jwt}
deviceId
required
string
Example: 94703EC2-0AAD-xxxxx-xxxxx-xxxxxxxxxx

Responses

Response samples

Content type
application/json
{
  • "accessRequests": [
    ]
}

Tracking decision

Cancel a request can only be cancelled when it is still In Progress.

path Parameters
request-id
required
string
Example: 1050

request-id using id from Request Tracking - Get list of request tracking API

header Parameters
Authorization
required
string
Example: Bearer {session-jwt}
deviceId
required
string
Example: 94703EC2-0AAD-xxxxx-xxxxx-xxxxxxxxxx
Request Body schema: application/json

A JSON object containing request body information

action
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "action": "cancel",
  • "comment": "this is the cancellation comment"
}

Response samples

Content type
application/json
{
  • "result": true
}