Skip to content
API Reference
/
/
Create User

Uniphore Business AI Cloud (1.0.0)

APIs for Uniphore Business AI platform spanning data, knowledge, models, and agents.

Metadata

KeyValue
ownerUniphore Technologies Pvt Ltd
teamBusiness AI
departmentEngineering
statusBeta
Download OpenAPI description
api.json
api.yaml
Languages
Servers
Demo Instance for Uniphore Business AI Cloud

https://forge-api-gateway-x-forge.dev.uniphorecloud.com/

Action Orchestrator

APIs for Actions Orchestration.

Operations

Agents

APIs for Agents.

Operations

Darwin

APIs for Darwin.

Operations

Evaluation

APIs for Evaluation of models

Operations

Inferencing

Pegasus APIs for Inferencing.

Operations

Meta Prompting

APIs for Meta Prompting & Prompt Management.

Operations

Platform Config

APIs for Platform Setup - Workflows, Sources, Destinations, Knowledge Bases etc.

Operations

Question & Answer

APIs for Question & Answering

Operations

Tag

APIs for Tag.

Operations

User Management

APIs for User Management - Users, Roles, Permissions etc.

Operations

Update User

Request

Updates a User

Bodyapplication/jsonrequired
idstring(uuid)
userIdstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of strings(uuid)
externalIdTokenobject
curl -i -X PUT \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/v1/users \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "email": "string",
    "source": "string",
    "version": 0.1,
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "firstTimeLogin": true,
    "expired": true,
    "status": "string",
    "role": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "externalIdToken": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

OK

Body*/*
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects

Create User

Request

Creates a new User

Bodyapplication/jsonrequired
idstring(uuid)
userIdstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of strings(uuid)
externalIdTokenobject
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/v1/users \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "email": "string",
    "source": "string",
    "version": 0.1,
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "firstTimeLogin": true,
    "expired": true,
    "status": "string",
    "role": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "externalIdToken": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

OK

Body*/*
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects

Update User

Request

Updates a User

Bodyapplication/jsonrequired
idstring(uuid)
userIdstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of strings(uuid)
externalIdTokenobject
curl -i -X PUT \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/users \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "email": "string",
    "source": "string",
    "version": 0.1,
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "firstTimeLogin": true,
    "expired": true,
    "status": "string",
    "role": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "externalIdToken": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

OK

Body*/*
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects

Create User

Request

Creates a new User

Bodyapplication/jsonrequired
idstring(uuid)
userIdstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of strings(uuid)
externalIdTokenobject
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/users \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
    "email": "string",
    "source": "string",
    "version": 0.1,
    "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",
    "userName": "string",
    "firstName": "string",
    "lastName": "string",
    "fullName": "string",
    "firstTimeLogin": true,
    "expired": true,
    "status": "string",
    "role": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "externalIdToken": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

OK

Body*/*
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects

Advanced Search User

Request

Advanced Searches Users with search criterion

Bodyapplication/jsonrequired
searchStringstring
entitystring
durationFlagstring
criteriaArray of objects(UserManagement.Criterion)
sortArray of objects(UserManagement.SortObject)
paginationobject(UserManagement.Pagination)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/v1/users/search \
  -H 'Content-Type: application/json' \
  -d '{
    "searchString": "string",
    "entity": "string",
    "durationFlag": "string",
    "criteria": [
      {
        "name": "string",
        "operator": "string",
        "value": "string",
        "valueType": "string"
      }
    ],
    "sort": [
      {
        "direction": "string",
        "nullHandling": "string",
        "ascending": true,
        "property": "string",
        "ignoreCase": true
      }
    ],
    "pagination": {
      "page": 0,
      "size": 0
    }
  }'

Responses

OK

Body*/*Array [
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects
]

Advanced Search User

Request

Advanced Searches Users with search criterion

Bodyapplication/jsonrequired
searchStringstring
entitystring
durationFlagstring
criteriaArray of objects(UserManagement.Criterion)
sortArray of objects(UserManagement.SortObject)
paginationobject(UserManagement.Pagination)
curl -i -X POST \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/users/search \
  -H 'Content-Type: application/json' \
  -d '{
    "searchString": "string",
    "entity": "string",
    "durationFlag": "string",
    "criteria": [
      {
        "name": "string",
        "operator": "string",
        "value": "string",
        "valueType": "string"
      }
    ],
    "sort": [
      {
        "direction": "string",
        "nullHandling": "string",
        "ascending": true,
        "property": "string",
        "ignoreCase": true
      }
    ],
    "pagination": {
      "page": 0,
      "size": 0
    }
  }'

Responses

OK

Body*/*Array [
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects
]

Get Current loggedIn User

Request

Reads the loggedIn User details

curl -i -X GET \
  https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/v1/users/me

Responses

OK

Body*/*
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects

Get User

Request

Reads a User given user Id

Path
idstring(uuid)required
curl -i -X GET \
  'https://forge-api-gateway-x-forge.dev.uniphorecloud.com/user-management/users/{id}'

Responses

OK

Body*/*
idstring(uuid)
emailstring
sourcestring
versionnumber(float)
tenantIdstring(uuid)
userNamestring
firstNamestring
lastNamestring
fullNamestring
firstTimeLoginboolean
expiredboolean
statusstring
roleArray of objects(UserManagement.IdNameDTO)
externalIdTokenArray of objects