Apply CustodyIn Scan

body

X-COREOS-REQUEST-ID

X-COREOS-TID

X-COREOS-ACCESS

X-COREOS-USERINFO

<p>callback secret (base64 encoded string)</p>

X-COREOS-CALLBACK-SECRET

Learn how to use the curl command to make seamless POST requests to a targeted API endpoint with this comprehensive code example. Discover how to efficiently handle parameters, headers, responses, and errors, while leveraging a callback option to seamless

Apply CustodyOut Scan

clientID

OS1 APIs

API Reference Overview

How to use the API 'Try It' feature

Overview

Create App Role

Get all Roles

Update a Role

Get specific role information.

Role Management

Create User

Get all Users.  Deprecated. It will reach EOL on Sept 30, 2023.

Update User

Get User

Get User Roles

Get Apps assigned to User

Block a User

Active a User by id

Unblock a blocked User. This API is deprecated. Use unblock user by userId

Get the user info from access token

Update (Add/remove) groups of the users

User Management

Otp generate request to Grant Token using otp mode of authentication

Otp verification to get the userId associated with that api.

Client credentials grant token

Authentication

Get all Connections

Create a Social Connection

Get Social Connection

Update Social Connection

Create SAML Connection

Get SAML Connection

Update SAML Connection

Create OIDC client

Update OIDC client

Get OIDC connection

Connection Management

Create Group

Get all Group

Update Group

Get Groups

Update users mapping for a Group. Please note that requests that exceed the 375KB size limit will be rejected. Avoid passing large payloads to prevent exceeding this limit.

Get all users in a Group

Update Roles mapping for a Group

Group Management

Authentication And Authorization (AAA) Service

Get details of tenant.

Update details of tenant.

Get Attribute Config of Tenant.

Update Attribute Config of Tenant.

Tenant

Create a new participant type

Get all participant types and their configurations

Get configuration of a participant type

Update participant type configuration

Participant Type

register custom code configurations of a participant type

update custom code configurations of a participant type

get custom code configurations of a participant type

Participant Type - Custom Code Config

Get custom attributes configurations of a participant type

Update custom attributes configurations for a participant type

Participant Type - Attributes Config

Get state-machine configurtion of a participant type

Update state machine configuration for a participant type

Update an Entity

Get all events

Create events for a participant-type

Update events for a participant-type

Get events for a participant-type

API to get list of orphan event codes (not associated with any reason code).

Post reasons for a participant type.

Get all reasons

Update reasons for a participant type.

Get reasons for a participant type.

API to get list of orphan reasons codes (not associated with any reason code).

Participant Type - State Machine

Create a new participant

Get list of participants of a participant type.

Get custom & core attribute values of a participant.

Update core and custom attributes of a participant.

Participant

Create a new Template

Get list of Templates of a participant type and category.

Get a template with a given id.

Update a template with a given id.

Get a template with a given category and subcategory

Update a template with a given category and sub category.

Templates

Get the current state of the participant.

Transition the current state of the participant.

Participant State

Perform create operation on participants in batch.

Perform update operation on participants in batch.

Get the status of batch request.

Perform create operation on participants via file upload.

Perform update operation on participants via file upload.

Get the status of batch file request.

Participant - Batch Processing

Participant Service

 Create a new container type

Fetch container type details based on the filters passed

Get container type deatils by containerTypeName

Update container type basic deatils

Container Type

register custom code configurations of a container type

update custom code configurations of a container type

get custom code configurations of a container type

Container Type - Custom Code Config

Get core attributes configurations of a container type

Update core attributes configurations for a Container type.

Container Type - Attributes Config

 Get state machine configuration of container type

 Update state machine configuration of container type

Create events for a container-type

Update events for a container-type

Get events for a container-type

Container Type - State Machine Config

Create a container

Fetch details of container

Update attribute of Container

Fetch container details based on the filters passed.

Fetch details of container by trackingId

containerization/decontainerization of the container

Container

Get the current state of a container

Apply event on the container.

Container State

Add containers to a group

Remove containers from a group

Get list of containers of a group

Apply event on a group of containers

Update attributes of containers in bulk

Container Group

Create container in batches

Perform update operation on container in batches

Get the status of batch  request

Perform create operation on container via file upload

Perform update operation on container via file upload

Get the status of batch file request

Container - Batch Processing

Container Service

Create a new job type

Get configuration of job types

Get configuration of a job type

update a job type

Job Type

Create a new job workflow draft

Create a new job workflow

Get job workflow by job workflow id

Update job workflow status

Job Workflow

Create a new job

Update job by job ref

Get job by job id

Update job by id

Update some values of custom data for a job

Change status and subStatus of a job

Change sub status of a job

Change sub status of jobs

cancel the job

Get attribute config of a job type

Post attribute config for job

Job - Config

Create a new dispatch type

Get configuration of dispatch types

Get configuration of a dispatch type

Dispatch Type

Create a new dispatch

Update all the values of custom data for a dispatch

Update some values of custom data for a dispatch

Change status and subStatus of a dispatch

Change sub status of a dispatch

Add job to a dispatch

Add multiple jobs to a dispatch

Remove multiple jobs from a dispatch

Remove a job from dispatch

Update job within dispatch on receiving acknowledgment

Add participant to a dispatch

Add multiple participants to a dispatch

Remove a participant from dispatch

Change status and subStatus of a dispatch by ref

Change sub status of a dispatch by ref

Add job to a dispatch by ref

Add multiple jobs to a dispatch by ref

Remove multiple jobs from a dispatch by ref

Remove a job from dispatch by ref

Add participant to a dispatch by ref

Add multiple participants to a dispatch by ref

Remove a participant from dispatch by ref

Update all the values of custom data for a dispatch by ref

Dispatch

Dispatch Service