Skip to main content
API docs by Redocly

One37ID - Business Connector JS Agent API (1.0)

Download OpenAPI specification:Download

Agent API for Business Connector JS

Swagger document

.well-known

Get DID configuration (did.json)

Responses

Get OpenID Credential Issuer Metadata (openid-credential-issuer)

Responses

Get DID Configuration file (did-configuration.json)

Responses

Get Agent profile (profile.json)

Responses

DIDComm

Handle DIDComm messages.

Responses

Url Shortener - Provided by UrlShortenerModule Library

Resolve and redirect to the original url from shortened link id (Guid).

query Parameters
_oobid
string

The Out-Of-Band shortened link id.

_oobsfid
string

The start workflow shortened link id with Out-Of-Band invite.

follow
boolean

Folow to resolved link?

Responses

Create a new single-use shortened link.

Request Body schema: application/json
required
requestUrl
required
string

The url to be shortened.

agentBaseUrl
string

The base url of the agent.

type
required
string
Enum: "public-invite" "init-flow" "other"

Link type.

isOneTimeUse
required
boolean

Is one time resolvable.

expiredAt
string <date-time>

Expiry date.

Responses

Request samples

Content type
application/json
{
  • "requestUrl": "string",
  • "agentBaseUrl": "string",
  • "type": "public-invite",
  • "isOneTimeUse": true,
  • "expiredAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
"string"

Delete a shortened link by id.

path Parameters
id
required
string

Responses

DID Exchange (establish connection)

Handle DIDComm messages.

Responses

Response samples

Content type
application/json
{ }

Invitation

Get invitation url.

Responses

Credential

TEMP! Create and verify signature from payload as any string.

query Parameters
payload
string

Alias.

Responses

TEMP! Get hex signature.

query Parameters
payload
string

Payload as a any string.

Responses

TEMP! Verify hex signature.

query Parameters
hexSignature
string

Signature in hex format.

Responses

Get credential details.

path Parameters
id
required
string

Credential identifier.

Responses

Schema Definition

Get json schema definition list.

query Parameters
page
number

Page number.

pagesize
number

Page size.

Responses

Response samples

Content type
application/json
{ }

Get json schema definition.

path Parameters
name
required
string

Schema name.

version
required
string

Schema version.

Responses

Response samples

Content type
application/json
{ }

Credential Status

Get credential revocation status.

path Parameters
statusList
required
string

Status list identifier and index (optional). Example, 5-129 where 5 is status list id and 129 index in list.

Responses

Alias Resolution Service

Resolve alias.

query Parameters
alias
string

Alias.

type
string
Enum: "default" "alias" "email" "domain" "phone"

Alias type.

realm
string

Business realm.

follow
boolean

Folow to resolved link?

Responses

Resolve fully qualified (encoded) alias.

path Parameters
alias
required
any

The alias.

Responses

Verify Email

Verify the email token

path Parameters
token
required
string

Responses

Start the email verification process

Request Body schema: application/json
required
email
required
string

Email address

displayName
required
string

Display name

connectionId
required
string

Connection Id

Responses

Request samples

Content type
application/json
{
  • "email": " [email protected]",
  • "displayName": "Bob",
  • "connectionId": "string"
}

Response samples

Content type
application/json
{ }

OpenID Connect Authentication

AuthOidcController_index

Responses

AuthOidcController_test

Responses

Response samples

Content type
application/json
{ }

InteractionController_login

path Parameters
uid
required
any

Responses

InteractionController_loginCheck

Responses

Send the proof request to the user

path Parameters
uid
required
any

The interaction UID

Responses

Response samples

Content type
application/json
{ }

InteractionController_confirmLogin

Responses

InteractionController_abortLogin

Responses

SAML2 Authentication

Get the SP metadata

path Parameters
index
required
number

The index of the SP configiration to fetch

Responses

Get the SAML IdP metadata

Responses

Handle initial SAML Auth request and show Login prompt to capture user Alias

path Parameters
alias
string

User Alias (url encoded)

Responses

Send the proof request to the user

Request Body schema: application/json
required
requestId
required
string

Login Request ID

alias
required
string

User Alias

issuer
required
string

Service Provider EntityID

Responses

Request samples

Content type
application/json
{
  • "requestId": "string",
  • "alias": "string",
  • "issuer": "string"
}

Response samples

Content type
application/json
{ }

Process the SAML Logout request

Responses

Metrics - Provided by MetricsModule Library

Create a new metric event.

Request Body schema: application/json
required
Id
string
Job
required
string
MetricName
required
string
MetricValue
required
number
Unit
required
string
ContactIdentifier
string
Tag
string
Tags
Array of strings
Created
string <date-time>
Default: "2024-11-18T13:07:45.669Z"

Responses

Request samples

Content type
application/json
{
  • "Id": "string",
  • "Job": "string",
  • "MetricName": "string",
  • "MetricValue": 0,
  • "Unit": "string",
  • "ContactIdentifier": "string",
  • "Tag": "string",
  • "Tags": [
    ],
  • "Created": "2024-11-18T13:07:45.669Z"
}

OidcController_mountedOidc_get

Responses

OidcController_mountedOidc_post

Responses

OidcController_mountedOidc_put

Responses

OidcController_mountedOidc_delete

Responses

OidcController_mountedOidc_patch

Responses

OidcController_mountedOidc_options

Responses

OidcController_mountedOidc_head

Responses

X

Graph View