Skip to main content

Smoke Suite (1.0.0)

Download OpenAPI specification:Download

Authorization

Access Token

This section describes how to procure an access token for authorization using the client credentials as a grant type.

path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
One of
grant_type
string

The grant type should be client_credentials.

client_id
string

The Client ID for which the access token is to be generated. NOTE- Make sure the Service Accounts Enabled option is switched to ON for the respective client.

client_secret
string

Secret corresponding to the given clientID. Secret will be available only for the clients with access type selected confidential during client creation. This is an optional parameter.

Responses

Request samples

Content type
application/json
{
  • "client_id": "{{Admin-Client}}",
  • "client_secret": "",
  • "grant_type": "password",
  • "password": "{{Admin-userPSW}}",
  • "scope": "kobil_password",
  • "username": "{{UserID}}"
}

Response samples

Content type
application/json
{
  • "access_token": "string",
  • "expires_in": 0,
  • "not-before-policy": 0,
  • "refresh_expires_in": 0,
  • "refresh_token": "string",
  • "scope": "string",
  • "session_state": "string",
  • "token_type": "string"
}

Well known API

From the provider's Well-Known Configuration Endpoint, returns the OpenID Connect configuration values. It specifies a sign-in flow that allows a client application to authenticate a user and acquire information (or "claims") about that user, such as the user's name, email id, and some other data. A secure JSON Web Token (JWT) called ID token is used to store user identity information.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{}

Users

Create User

Create User

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
object

Based on the requirement, the user attributes can be updated. User can add any customized attribute in form of key value pair.

object

Configure the client roles for which the actions need to be performed by the user.

Array of objects

User credentials.

email
string

Email corresponding to the user.

emailVerified
boolean

Does emailVerified enabled or not? true = enable & false = disable, Defaults to true.

enabled
boolean

Does user enabled or not? true = enable & false = disable, Defaults to true.

firstName
string

First name of the user.

groups
Array of strings

Provide the user group name

lastName
string

Provide the lastname

username
string

Provide the username

realmRoles
Array of strings

Configure the realmRoles for which the actions need to be performed by the user.

requiredActions
Array of strings

Provide the required action

Responses

Request samples

Content type
application/json
{
  • "attributes": {
    },
  • "clientRoles": {
    },
  • "credentials": [
    ],
  • "email": "bob.go@gmail.com",
  • "emailVerified": true,
  • "enabled": true,
  • "firstName": "bob",
  • "groups": [
    ],
  • "lastName": "s",
  • "username": "user",
  • "realmRoles": [
    ],
  • "requiredActions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "User created successfully",
  • "status": "OK",
  • "subSystem": 5
}

Update User

Update User

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

userId
required
string

Provide the Realm name.

Request Body schema: application/json
Array of objects

User credentials

object

Configure the client roles for which the actions need to be performed by the user.

object

Based on the requirement, the user attributes can be updated. User can add any customized attribute in form of key value pair.

email
string

Email of the user.

emailVerified
boolean

Does emailVerified enabled or not? true = enable & false = disable, Defaults to true.

enabled
boolean

Does user enabled or not? true = enable & false = disable, Defaults to true.

firstName
string

First name of user

lastName
string

Last name of user.

realmRoles
Array of strings

Configure the realmRoles for which the actions need to be performed by the user.

username
string
requiredActions
Array of strings

Provide the required action

Responses

Request samples

Content type
application/json
{
  • "credentials": [
    ],
  • "clientRoles": {
    },
  • "attributes": {
    },
  • "email": "bob@gmail.com",
  • "emailVerified": true,
  • "enabled": true,
  • "firstName": "bob",
  • "lastName": "S",
  • "realmRoles": [
    ],
  • "username": "test",
  • "requiredActions": [
    ]
}

Response samples

Content type
application/json
{
  • "message": "User updated successfully",
  • "status": "OK",
  • "subSystem": 5
}

Get User By UUID

The Get User with UUID API will return a list showing the user details.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

id
required
string

Configure the UserId.

Responses

Response samples

Content type
application/json
{
  • "id": "5698e30c-7e33-44ee-9dce-3fa328831e66",
  • "createdTimestamp": 1692020930000,
  • "username": "idp_external_admin",
  • "enabled": true,
  • "emailVerified": false,
  • "attributes": {
    },
  • "disableableCredentialTypes": [
    ],
  • "requiredActions": [
    ],
  • "notBefore": 0,
  • "access": {
    }
}

Update profile User

Use this API to update the user profile.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the Version.

Username
required
string

Configure the user name.

Request Body schema: application/json
firstName
string

First name of the user.

lastName
string

Last name of the user.

email
string

Email of the user.

object

Key value pair containing the attributes you wanted to update.

Responses

Request samples

Content type
application/json
{
  • "firstName": "Foo",
  • "lastName": "Bar",
  • "email": "tom@bob.com",
  • "attributes": {
    }
}

Response samples

Content type
application/json
{
  • "message": "User profile updated successfully.",
  • "status": "OK",
  • "subSystem": 5
}

Get Users Based On Client Role

The Get Users Based On Client Role API returns a list of users who have the specified client role.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the version.

clientRole
required
string

Configure the Client Role name.

assignedRole
required
string

Configure the Assigned Role name.

query Parameters
limit
string
Example: limit=1

Provide the limit.

offset
string
Example: offset=1

Provide the offset.

isUserEnabled
string
Example: isUserEnabled=true

Enable user. Per Default false.

isEmailVerified
string
Example: isEmailVerified=false

Unique email corresponding to the user.

firstName
string
Example: firstName=grootan

First name of user.

lastName
string
Example: lastName=groot

Last name of user.

email
string
Example: email=accesstoken@gmail.com

Email corresponding to the user

username
string
Example: username=accesstoken

Unique username of the user.

orderBy
string
Example: orderBy=asc

Provide "asc or desc" to order it.

orderByKey
string
Example: orderByKey=username

firstName or lastName or email or username.

genericSearchVal
string
Example: genericSearchVal=accesstoken

It is a customized search for first name, last name, email, or username, and if the search is empty, we will consider the firstname, lastname, email, and username parameters, else these four parameters will be ignored.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Users fetched successfully",
  • "status": "Success",
  • "subSystem": 5
}

Get Users Based On Role

The Get Users Based On Role API returns a list of users who have the specified role. The user's list will be ordered alphabetically according to the username.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the version.

role
required
string

Configure the Role name.

query Parameters
firstName
string
Example: firstName=grootan

First name of user.

lastName
string
Example: lastName=groot

Last name of user.

email
string
Example: email=accesstoken@gmail.com

Email corresponding to the user.

username
string
Example: username=accesstoken

Unique username of the user.

orderBy
string
Example: orderBy=desc

Enter "asc or desc" to provide the order details.

orderByKey
string
Example: orderByKey=lastname

firstName or lastName or email or username are used to produce the list based on the Key

genericSearchVal
string
Example: genericSearchVal=groot

It is a customized search for first name, last name, email, or username, and if the search is empty, we will consider the firstname, lastname, email, and username parameters, else these four parameters will be ignored.

limit
string
Example: limit=1

Provide the limit.

offset
string
Example: offset=1

Provide the offset.

isUserEnabled
string
Example: isUserEnabled=true

Enable user. Per Default false

isEmailVerified
string
Example: isEmailVerified=false

Unique email corresponding to the user.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Users fetched successfully",
  • "status": "Success",
  • "subSystem": 5
}

Get User Info

Use this API to get the user details.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

UserID
required
string

Configure the Admin User Id.

query Parameters
firstName
string
Example: firstName=grootan
value
string
Example: value=12
limit
string
Example: limit=1
pageNumber
string
Example: pageNumber=1

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "User info fetched successfully",
  • "status": "Success",
  • "subSystem": 5
}

Get User By User group

The Get User By User group will filter and search User options based on provided search values.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

groupID
required
string

Configure the Group id .

query Parameters
limit
string
Example: limit=1

provide limit

offset
string
Example: offset=1

provide offset

isUserEnabled
string
Example: isUserEnabled=true

Enable user. Per Default false

orderBy
string
Example: orderBy=desc

Provide "asc or desc" to order it.

orderByKey
string
Example: orderByKey=lastname

firstName or lastName or email or username or createdTimestamp (to provide each user's creation time)

genericSearchVal
string
Example: genericSearchVal={string}

It is a customized search for first name, last name, email, or username, and if the search is empty, we will consider the firstname, lastname, email, and username parameters, else these four parameters will be ignored.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Users fetched successfully",
  • "status": "Success",
  • "subSystem": 5
}

Get User Status

The Get User Status API will return a list showing the user was locked via Bruteforce or not.

path Parameters
tenantId
required
string

Provide the Realm name.

username
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "otp_disabled": true,
  • "otp_numFailures": 1,
  • "otp_lastIPFailure": 1.1,
  • "otp_lastFailure": 345678908
}

Get OTP Brute Force Status

TThe Get OTP Brute Force status Digitanium API gets OTP Brute Force lock status of a user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

userName
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "message": "User Otp brute force status fetched successfully",
  • "status": "success",
  • "subsystem": 0,
  • "data": null
}

Unlock User OTP Brute Force

The Unlock User OTP Brute Force Digitanium API will unlock the user locked by the OTP Brute Force.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

userName
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "message": "User unlocked from OTP brute force successfully",
  • "status": "Success",
  • "subSystem": 5
}

Search User

API to search the users.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

query Parameters
key
string
Example: key={{search_keyword}}

It can be a search parameter and will search over username, firstname, lastname and email.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Users fetched successfully",
  • "status": "Success",
  • "subSystem": 5
}

Search User By User Attribute

API to search and fetch the user list using user's attributes.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

query Parameters
key
string
Example: key={{userkey}}

Provide Attribute Name.

value
string
Example: value={{uservalue}}

Provide Attribute value to search.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Users fetched successfully",
  • "status": "Success",
  • "subSystem": 5
}

Unlock All User OTP Brute Force

The Unlock all Users OTP Brute Force Digitanium API will unlock all the users locked by the OTP Brute Force.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "message": "All users unlocked from OTP brute force successfully",
  • "status": "Success",
  • "subSystem": 5
}

Update Profile User

Use this API to update the user profile.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

userName
required
string

Configure the user name.

Request Body schema: application/json
firstName
string

First name of the user.

lastName
string

Last name of the user.

email
string

Email of the user.

object

Key value pair containing the attributes you wanted to update.

Responses

Request samples

Content type
application/json
{
  • "firstName": "Foo",
  • "lastName": "Bar",
  • "email": "example@email.com",
  • "attributes": {
    }
}

Response samples

Content type
application/json
{
  • "message": "User updated successfully",
  • "status": "Success",
  • "subSystem": 5
}

Disable User

This API is used to disable a mID user temporarily. Disabled users will not be allowed to login.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Username
required
string

Configure the user name.

Request Body schema: application/json
enabled
boolean

False - Disable user

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "User updated successfully",
  • "status": "Success",
  • "subSystem": 5
}

Enable User

Use this API to enable the user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
enabled
boolean

True - Enable user

Responses

Request samples

Content type
application/json
{
  • "enabled": false
}

Response samples

Content type
application/json
{
  • "message": "User updated successfully",
  • "status": "Success",
  • "subSystem": 5
}

Promote User

Once promoted the user will have the 'digitanium_admin' role tagged and the corresponding role permissions.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Username
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "message": "User promoted successfully",
  • "status": "Success",
  • "subSystem": 5
}

Revoke Admin access

Deletes the admin role permission for a particular user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Username
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "message": "Admin access revoked successfully",
  • "status": "OK",
  • "subSystem": 5
}

User Tenant List

Returns the list of tenants for a particular user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Username
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "data": "astqa",
  • "message": "Tenant list fetched successfully",
  • "status": "OK",
  • "subSystem": 5
}

Revoke Required Actions

Using this API, users required actions can be revoked. The actions can be performed even when the user is locked or disabled.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Username
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "message": "User required actions revoked successfully",
  • "status": "OK",
  • "subSystem": 5
}

Revoke Roles

Using this API client and realm roles will be revoked from the user's.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Username
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "message": "User roles revoked successfully",
  • "status": "OK",
  • "subSystem": 5
}

List Admin Users

List Admin Users API will return a list of admin users.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Admin users fetched successfully",
  • "status": "Success",
  • "subSystem": 5
}

Delete User

Delete User API is used to delete a user, which was created using Create User.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Username
required
string

Configure the user name.

Responses

Response samples

Content type
application/json
{
  • "message": "User deleted successfully",
  • "status": "OK",
  • "subSystem": 5
}

Add address

Add Address API will add the address for the requested user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

UserID
required
string

Configure the Admin User Id.

Request Body schema: application/json
postalCode
string

Define the postalCode of the given address.

Responses

Request samples

Content type
application/json
Example
{
  • "addressDetails": "addressDetails",
  • "addressTitle": "Home address",
  • "addressType": "Home",
  • "city": "scotland",
  • "cityCode": "625531",
  • "defaultAddress": true,
  • "directions": "",
  • "district": "kanchipuram",
  • "districtCode": "123456",
  • "firstName": "arun",
  • "lastName": "raj",
  • "postalCode": "654321",
  • "town": "hometown",
  • "townCode": "625521"
}

Response samples

Content type
application/json
{
  • "message": "Success",
  • "status": "Address added successfully",
  • "subSystem": 5
}

Get address

Get Address API will fetch the address of the requested user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

UserID
required
string

Configure the Admin User Id.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Success",
  • "status": "Address info fetched successfully",
  • "subSystem": 5
}

Edit Address

Edit Address API will update the address for the requested user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

UserID
required
string

Configure the Admin User Id .

Request Body schema: application/json
addressID
string

Define the addressID given for a particular address.

Responses

Request samples

Content type
application/json
{
  • "addressID": ""
}

Response samples

Content type
application/json
{
  • "message": "Address changed successfully.",
  • "status": "Success",
  • "subSystem": 5
}

Delete Address

Delete Address API will delete the address of the requested user.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

UserID
required
string

Configure the Admin UserId.

Responses

Response samples

Content type
application/json
{
  • "message": "Address deleted successfully",
  • "status": "Success",
  • "subSystem": 5
}

List Users

List Users will return a list of user's, along with their details that match the given query parameters.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "message": "Users fetched successfully",
  • "status": "Success",
  • "subSystem": 5,
  • "data": {
    }
}

Add User Group

Use this API to add the users within a group.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

username
required
string

Configure the user name.

Request Body schema: application/json
groups
Array of objects

Mention the groups where user need to be added.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "User group added successfully.",
  • "status": "OK",
  • "subSystem": 5
}

Delete User Group

User Group Delete API is used to remove the users from the group.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

username
required
string

Configure the user name.

Request Body schema: application/json
groups
Array of objects

Mention the groups where user need to be added.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "User group removed successfully.",
  • "status": "OK",
  • "subSystem": 5
}

Email

Send Email

Email will be sent to the user's based on the template which is specified in the mailtype.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
mailType
string

Specify the mail type for template. Value should be "WELCOME"

iosLink
string

Specify the iOS link.

androidLink
string

Specify Android link.

portalUrl
string

Specify the Portal access URL.

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "message": "The mail was sent successfully to the user.",
  • "status": "OK",
  • "subSystem": 7
}

SMTP Configuration

SMTP Configuration API used configure the email configurations.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
envelopeFrom
string

An email address used for bounces.

from
string

Enter from mailId.

fromDisplayName
string

A user friendly display name for from address.

host
string

Enter valid host(Eg.smtp.gamil.com).

password
string

Password corresponding to from mail address.

port
string

Enter valid port number.

replyTo
string

Mail to which reply needs to be sent.

replyToDisplayName
string

A user friendly display name for from address.

ssl
string

Enable SSL.

starttls
string

enable TLS.

user
string

From mail address.

Responses

Request samples

Content type
application/json
{
  • "envelopeFrom": null,
  • "from": "admin@midentitybox.com",
  • "fromDisplayName": "Identity Dashboard",
  • "host": "mail2.kobil.com",
  • "password": "AEV+d3P.n9Wr-aR",
  • "port": "587",
  • "replyTo": "admin@midentitybox.com",
  • "replyToDisplayName": "Support",
  • "ssl": "true",
  • "starttls": "true",
  • "user": "admin.midentitybox"
}

Response samples

Content type
application/json
{
  • "message": "Successfully updated SMTP details.",
  • "status": "OK",
  • "subSystem": 7
}

Test SMTP Configuration

The Test SMTP Configuration API is utilized to verify the email settings that have been configured.

Authorizations:
BearerAuth
path Parameters
tenantid
required
string
Request Body schema: application/json
mailType
string

Responses

Request samples

Content type
application/json
{
  • "mailType": "TEST"
}

Response samples

Content type
application/json
{
  • "message": "Mail Sent Successfully to the user",
  • "status": "OK",
  • "subSystem": 7
}

Apps (Client)

UMA App

Use this API to access a resource on the resource server which is secured based on the given query parameters.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

query Parameters
adminuser
required
string

Configure the Admin user name.

adminpassword
required
string

Configure the Admin Password.

migrate
required
boolean

Responses

Response samples

Content type
application/json
{
  • "message": "Created app and migrated users successfully.",
  • "status": "OK",
  • "subSystem": 2
}

List all apps

List all apps API will return the list of apps that are created through the Create App.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the Version.

Responses

Response samples

Content type
application/json
{
  • "message": "Apps info fetched successfully",
  • "status": "OK",
  • "subSystem": 2,
  • "data": [
    ]
}

Update App

Use Update App API, to update the app through IDP, which has already been created using Create App.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the Version.

Request Body schema: application/json
appName
string

The name of the app to be updated.

implicitFlowEnabled
boolean

Enable or not to enable directAccessGrants for this client.

Responses

Request samples

Content type
application/json
{
  • "appName": "addoz",
  • "implicitFlowEnabled": true
}

Response samples

Content type
application/json
{
  • "message": "App updated successfully.",
  • "status": "OK",
  • "subSystem": 2
}

Create App

Apps are entities that can request IDP to authenticate a user. It also use IDP to encrypt themselves and provide a single sign-on solution which can securely invoke other services over the network.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the Version.

Request Body schema: application/json
appName
string

The name of the app to be created.

id
string

This is a unique auto-generated id.

Responses

Request samples

Content type
application/json
{
  • "appName": "",
  • "id": "client123"
}

Response samples

Content type
application/json
{
  • "message": "App created successfully",
  • "status": "OK",
  • "subSystem": 2
}

Get App Info

Get App Info API will return the app info that match the given parameters.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the Version.

appname
required
string

Configure the App name.

query Parameters
appname
string
Example: appname={{appname}}

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "OK",
  • "subSystem": 2,
  • "data": {
    }
}

Delete App

Delete App is used to delete an app, which has already been created using Create App.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the Version.

appname
required
string

Configure the App name.

Responses

Response samples

Content type
application/json
{
  • "message": "App delete successfully",
  • "status": "OK",
  • "subSystem": 2
}

Regenerate App Credential

Regenerate App Credential API will return the data that match the given parameters.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Configure the App Version.

appname
required
string

Configure the App name.

query Parameters
appname
string
Example: appname={{appname}}
Request Body schema: text/plain
Schema not provided

Responses

Request samples

Content type
text/plain
Example

Response samples

Content type
application/json
{
  • "message": "App credential regenerated successfully.",
  • "status": "OK",
  • "subSystem": 2,
  • "data": "77581f16-2887-4d60-9346-0f3b6693063a"
}

Get App Credentials

Get App Credentials API will return a the data that match the given parameters.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

version
required
string

Version of the App.

clientID
required
string

Configure the Client ID.

Responses

Response samples

Content type
application/json
{
  • "message": "App credential fetched successfully",
  • "status": "OK",
  • "subSystem": 5,
  • "data": "77581f16-2887-4d60-9346-0f3b6693063a"
}

Send Magic Link

Authenticate user through email via link.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
clientId
string
email
string

Configure the email through which magic link will be sent.

forceCreate
boolean

Create user with the email when user doesn't exist.

redirectUri
string

Specify the URI, where user needs to land after completing the process.

resetPassword
boolean

reset password option is enabled while clicking the Magic link.

responseMode
string

Configure the type how the Authorization Server should return the result.

responseType
string

Configure the type of response that has to be received on execution.

scope
string

The scope requested for the token.

Responses

Request samples

Content type
application/json
Example
{
  • "clientId": "test",
  • "email": "",
  • "forceCreate": false,
  • "resetPassword": true,
  • "responseMode": "form_post",
  • "responseType": "code token",
  • "scope": "open_id"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "status": "OK",
  • "subSystem": 7
}

Tenant

Create tenant

Tenant are entities that can request IDP to authenticate a user. It also use IDP to encrypt themselves and provide a single sign-on solution which can securely invoke other services over the network. Access this API to create a new tenant.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
adminEmail
string

Define an email of admin user.

adminFirstName
string

Define Firstname of admin user.

adminLastName
string

Define Lastname of admin user.

adminPassword
string

Define new password of admin user.

adminUsername
string

Define unique username of admin user.

allowRegistration
boolean

If this is set to true the realm is enabled.

enableTenant
boolean

If this is set to true the realm is enabled.

registerEmailAsUsername
boolean

Define unique username of admin user.

rememberMe
boolean

If true allows user to remain logged in until session expires.

resetPassword
boolean

If true reset password option in login screen is enabled for the tenant.

tenantName
string

Specify Tenant name.

Responses

Request samples

Content type
application/json
{
  • "adminEmail": "test@testadmin.com",
  • "adminFirstName": "first",
  • "adminLastName": "last",
  • "adminPassword": "admin123",
  • "adminUsername": "admin",
  • "allowRegistration": true,
  • "enableTenant": true,
  • "registerEmailAsUsername": false,
  • "rememberMe": true,
  • "resetPassword": true,
  • "tenantName": "sujith"
}

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Tenant created successfully",
  • "status": "OK",
  • "subSystem": 1
}

List Tenants

Use this API to return the list of tenants along with their details.

Authorizations:
BearerAuth
path Parameters
tenantid
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "message": "Tenant list fetched successfully",
  • "status": "OK",
  • "subSystem": 1
}

Get Tenant Info

Get Tenant Info API is used to get the details about the tenant.

Authorizations:
BearerAuth
path Parameters
tenantName
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Tenant info fetched successfully.",
  • "status": "OK",
  • "subSystem": 1
}

Update Tenant

Update Tenant is used to update the tenant, which was created using Create Tenant.

Authorizations:
BearerAuth
path Parameters
tenantName
required
string

Provide the Realm name.

Request Body schema: application/json
enableTenant
boolean

If this is set to true the realm is enabled.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "Tenant updated successfully",
  • "status": "OK",
  • "subSystem": 1
}

Get Tenant Settings

Using this API, we can fetch the details about the tenant settings.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Tenant setting(s) fetched successfully",
  • "status": "OK",
  • "subSystem": 1
}

Update Tenant Settings

Using this API, we can add/update the realm settings.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
enabled
string

Provide a name of the "Value" needs to be added/updated.

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "message": "Tenant settings updated successfully",
  • "status": "OK",
  • "subSystem": 1
}

Delete Tenant Settings

Use the Delete Tenant Settings API to delete the realm settings in a particular realm.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

query Parameters
key
string
Example:

provide the settings name which needs to be deleted.

Responses

Response samples

Content type
application/json
{
  • "message": "Tenant setting deleted",
  • "status": "Success",
  • "subSystem": 1
}

Get App Settings

The Get App settings API will fetch the app settings details which is configured in the realm settings.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "data": {
    },
  • "message": "Tenant setting(s) fetched successfully",
  • "status": "OK",
  • "subSystem": 1
}

Update App Settings

The Update App Settings API will update the app settings details which is configured in the realm settings.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
flutter_android_build_number
string

flutter_android_build_number is the number of android releases for a version. (Every build has its own unique number)

flutter_android_link
string

flutter_android_link is the URL for the playstore.

flutter_android_update_by
string

flutter_android_update_by results the timestamp of the last update.

flutter_android_version
string

flutter_android_version is the result of the andriod version.

flutter_ios_build_number
string

flutter_ios_build_number is the number of ios releases for a version. (Every build has its own unique number)

flutter_ios_link
string

flutter_ios_link is the URL for the appstore.

flutter_ios_update_by
string

flutter_ios_update_by results the timestamp of the last update.

flutter_ios_version
string

flutter_ios_version is the result of the ios version.

macos_build_number
string

macos_build_number is the number of macos releases for a version. (Every build has its own unique number).

macos_link
string

macos_link is the URL for the playstore.

macos_update_by
string

macos_update_by results the timestamp of the last update.

macos_version
string

macos_version is the result of the macos version.

windows_build_number
string

windows_build_number is the number of windows releases for a version. (Every build has its own unique number)

windows_link
string

windows_link is the URL for the playstore.

windows_update_by
string

windows_update_by results the timestamp of the last update.

windows_version
string

windows_version is the result of the windows version.

Responses

Request samples

Content type
application/json
{
  • "flutter_android_build_number": "000",
  • "flutter_android_link": "https://google.com",
  • "flutter_android_update_by": "30.07.2023",
  • "flutter_android_version": "2.5.5",
  • "flutter_ios_build_number": "000",
  • "flutter_ios_link": "https://google.com",
  • "flutter_ios_update_by": "30.07.2023",
  • "flutter_ios_version": "2.5.5",
  • "macos_build_number": "",
  • "macos_link": "",
  • "macos_update_by": "",
  • "macos_version": "",
  • "windows_build_number": "",
  • "windows_link": "",
  • "windows_update_by": "",
  • "windows_version": ""
}

Response samples

Content type
application/json
{
  • "message": "Tenant updated successfully",
  • "status": "OK",
  • "subSystem": 1
}

Add Realm Role

A New realm specific role can be created using this API.

path Parameters
tenantId
required
string

Provide the Realm name.

roleName
required
string

Configure the Role name.

Responses

Response samples

Content type
application/json
{
  • "message": "Role created successfully",
  • "status": "OK",
  • "subSystem": 1
}

Delete Realm Role

Existing Realm roles can be deleted using this API.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

roleName
required
string

Configure the Role name.

Responses

Response samples

Content type
application/json
{
  • "message": "Role deleted successfully",
  • "status": "OK",
  • "subSystem": 1
}

Get Realm Creation Status

The Get Realm Creation Status API that will fetch the status of the Realm created.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "status": "BLOCKED",
  • "iamStatus": "SUCCESS",
  • "signerCertStatus": "BLOCKED",
  • "identityUserCertStatus": {
    }
}

Delete Tenant

Delete Tenant is used to delete a tenant, which was created using Create Tenant.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

tenantName
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "message": "Tenant deleted successfully",
  • "status": "OK",
  • "subSystem": 5
}

Riskbits

Create riskbits

Using this API, riskbits can be added/created as provided in the request.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
operation
string

Device execution is determined by the risk operation. For instance, if the JBreak[1]40001 is the Risk name of the device in 'Risk Details iOS' is 'HIGH_RISK,'in Operation the device will not be allowed.

ratingLevel
string

Assessing the Risk Level on the device.

realmId
string

The "realmId" field serves as an identifier for a specific tenant within a system.

risk
string

Rate of the risks.

riskAndroid
string

Android risk name which is present in the device.

riskIOS
string

iOS risk name which is present in the device.

score
string

Qualitative measure that quantifies the degree of the risk.

Responses

Request samples

Content type
application/json
{
  • "operation": "OK",
  • "ratingLevel": "X",
  • "realmId": "aaiqa",
  • "risk": "0.01",
  • "riskAndroid": "JBreak_test",
  • "riskIOS": "JBreak_test",
  • "score": "001-003"
}

Response samples

Content type
application/json
{
  • "message": "Riskbits added successfully",
  • "status": "OK",
  • "subSystem": 1
}

Delete All Riskbits

Using this API, riskbits which are added using Add List of Riskbits will be removed/deleted.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "message": "All Riskbits Deleted Successfully",
  • "status": "OK",
  • "subSystem": 1
}

Get Riskbits

Using this API, will return the list of riskbit details for the riskbitId provided in the request.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

riskbitid
required
string

Configure the riskbit id.

Responses

Response samples

Content type
application/json
{
  • "id": "fa8975fc-a3b6-42f4-85d6-1107ec5fe864",
  • "ratingLevel": "A",
  • "score": "986-999",
  • "risk": "0.80",
  • "riskAndroid": "",
  • "riskIOS": "",
  • "operation": "none",
  • "realmId": "demokc"
}

Add List of Riskbits

Using this API, riskbits can be added in a list as provided in the request.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
Array
operation
string

Device execution is determined by the risk operation. For instance, if the JBreak[1]40001 is the Risk name of the device in 'Risk Details iOS' is 'HIGH_RISK,'in Operation the device will not be allowed.

ratingLevel
string

Assessing the Risk Level on the device.

realmId
string

The "realmId" field serves as an identifier for a specific tenant within a system.

risk
string

Risk name.

riskAndroid
string

The "riskAndroid" field pertains specifically to the name.

riskIOS
string

iOS risk name which is present in the device.

score
string

Qualitative measure that quantifies the degree of the risk.

Responses

Request samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Response samples

Content type
application/json
{
  • "message": "Riskbits added successfully",
  • "status": "OK",
  • "subSystem": 1
}

Get All Riskbits

Using this API, will return the list of riskbit details.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Verify Device Risk

Using this API will fetch the device risk.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
platform
string
riskName
string

Responses

Request samples

Content type
application/json
{
  • "platform": "ios",
  • "riskName": "JBreak"
}

Response samples

Content type
application/json
[
  • {
    }
]

Get Riskbit Status

Using this API, updated/added riskbits details can be fetched.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Responses

Response samples

Content type
application/json
{
  • "id": "929f0a33-3434-48f6-b735-5eb055835945",
  • "realmId": "xxxtenant",
  • "enabled": true
}

Add Or Update Riskbit Status

Using this API, riskbit can be updated/added for the provided riskbitId in the request.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

Request Body schema: application/json
enabled
boolean

Enabled status.

id
string

Unique identifier for each riskbit, providing a distinct reference for tracking and managing individual instances of risk within a system.

realmId
string

The "realmId" field serves as an identifier for a specific tenant within a system.

Responses

Request samples

Content type
application/json
{
  • "enabled": true,
  • "id": "ef08c996-55e3-40c5-ad2b-6038b4e05921",
  • "realmId": "aaiqa"
}

Response samples

Content type
application/json
{
  • "id": "929f0a33-3434-48f6-b735-5eb055835945",
  • "realmId": "xxxtenant",
  • "enabled": true
}

Delete Riskbits

Using this API, riskbits which are added/created using Create Riskbits will be removed/deleted.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

id
required
string

Configure the Riskbit Id.

Responses

Response samples

Content type
application/json
{
  • "message": "All Riskbits Deleted Successfully",
  • "status": "OK",
  • "subSystem": 1
}

OTP

Send OTP

Using this API, OTP can be sent via SMS or Email.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

VERIFICATION_USER_ID
required
string

Configure the VERIFICATON_USER_ID.

Request Body schema: application/json
code
string

Code can customised to personalize the OTP; otherwise, a code will be generated automatically.

codeLength
number

When not providing a custom code, set the desired code length (integer).

codeType
string

If codeLength is set, choose the code type as "NUMERIC," "ALPHANUMERIC," or "ALPHANUMERIC_WITH_SPECIAL_CHARACTERS."

codeValidity
string

Set the OTP's validity period using a format like "2m" for 2 minutes; the default validity is 5 minutes.

deliverViaInternalProvider
boolean

If set to "true," the OTP will be sent using an internal provider by default; if set to "false," the OTP won't be sent to the user but will be stored exclusively by the Identity Provider (IDP).

type
string

Specify the message type by setting this parameter as either "SMS" or "EMAIL.

Responses

Request samples

Content type
application/json
{
  • "code": "123456",
  • "codeLength": 6,
  • "codeType": "NUMERIC",
  • "codeValidity": "1m",
  • "deliverViaInternalProvider": true,
  • "type": "SMS"
}

Response samples

Content type
application/json
{
  • "message": "OTP sent to the user successfully",
  • "status": "OK",
  • "subSystem": 9
}

Verify OTP

Using this API, SMS or Email OTP can be verified.

Authorizations:
BearerAuth
path Parameters
tenantId
required
string

Provide the Realm name.

USER_NAME
required
string

Configure the user name.

Request Body schema: application/json
code
string

Responses

Request samples

Content type
application/json
{
  • "code": "123456"
}

Response samples

Content type
application/json
{
  • "message": "OTP verified successfully",
  • "status": "OK",
  • "subSystem": 9
}