Skip to main content
API docs by Redocly

IDHub API (1.0.0)

Download OpenAPI specification:Download

Overview

Welcome to the Developer Guide! This comprehensive resource is designed to empower you with the knowledge and tools needed to seamlessly integrate and interact with IDHub APIs. Whether you're a seasoned developer or just starting, this guide covers the essential steps, API endpoints, authentication processes, and best practices.

API Guide

IDHub API v1 is a stateless API whose output is in JSON format. The API is validated against an API token. This reference provides help with implementing the RESTful API. The IDHub API covers the majority of the functionality of our core product. The API is constantly evolving, just like our product.

Authorization

The authorization is done using the OAuth2 protocol. You have to use the KeyCloak token and provide the tenant header (or tenantID).

jwt

Security Scheme Type: HTTP
HTTP Authorization Scheme: bearer

Request

This section guides users to use endpoints in IDHub for tasks such as searching the catalog, adding items to a cart, and submitting access requests. It emphasizes the use of filters and specific endpoints for request details and submission.

Search

This Endpoint allows you to search the catalog using the display name of the item which contains the search keyword. You can further narrow down your search using the relevanceFilter, collection and tags.

Authorizations:
jwt
query Parameters
keyword
string

This is the search keyword used to get the response.

relevanceFilter
string

If you want to further filter the response using relevant filter, then you need to relevanceFilter value in the Query parameter. One of the relevanceFilter can be "recentlyAdded"

collection
string

Get specific catalog items using the filter collection. For entitlement, specify collection as Entitlement, for roles it would be "Roles", for users it would be "Users", for service request it would be "ServiceRequest" and for application it would be "TargetSystem"

tag
string

If you want to further filter the response using tag filter, then you need to tag value in the Query parameter. Tag filter examples can be "Finance", "HR" etc.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch by ID

This Endpoint will give you the details of a Request by ID

Authorizations:
jwt
path Parameters
id
required
string

id of the request object that you want to fetch

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Fetch by Type

This Endpoint will give you the details of a Request by type

Authorizations:
jwt
query Parameters
filter
string

This is the type of the request that you want to filter. Requests can be create, modify, revoke.

pagesize
string

This is the page size number

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create

In order to submit a request for provisioning/de-provisioning, revoke or modification of accounts. You need to first create a new cart for those items using this endpoint and then submit the cart using the submit request endpoint.

Learn more about submit request endpoint
Authorizations:
jwt
Request Body schema: application/json

User Cart with beneficiary, requester and cart items

object non-empty

This would include the requester details like - user login

Array of objects non-empty

This would include the beneficiary details, entityID and entityType. You can request for applications/entitlements/roles. You can filter the appropriate entity using the entityID and you can search for the same using the search catalog endpoint

Learn more about search catalog endpoint
owner
string

owner of the cart - user login

name
string

name of the cart

Responses

Request samples

Content type
application/json
{
  • "requester": {
    },
  • "cartItems": [
    ],
  • "owner": "User/63aec79793ccdf675cc4d018",
  • "name": "default"
}

Response samples

Content type
application/json
{
  • "correlationId": "657820f1171a9761e416ee25",
  • "result": true
}

Submit

This Endpoint allows you to create a request by submitting the cart. Before you can submit the request, you need to first create a new cart with the items that you want to request access using the Create a new request endpoint.

Learn more about create a new request endpoint
Authorizations:
jwt
Request Body schema: application/json

User Cart with beneficiary, requester and cart items

object non-empty

This would include the requester details like - user login

Array of objects non-empty

This would include the beneficiary details, entityID and entityType. You can request for applications/entitlements/roles. You can filter the appropriate entity using the entityID and you can search for the same using the search catalog endpoint

Learn more about search catalog endpoint
owner
string

owner of the cart - user login

name
string

name of the cart

accessToken
string

If you have an access token, you can specify this here

archive
boolean
Enum: true false
justification
string

Here you can enter the justification for the request that you are submitting

modifiedOn
date
collection
string
object

Responses

Request samples

Content type
application/json
{
  • "requester": {
    },
  • "cartItems": [
    ],
  • "owner": "User/63aec79793ccdf675cc4d018",
  • "name": "default",
  • "accessToken": "99849abbchf04khgjkg",
  • "archive": false,
  • "justification": "Submitting Request for Access to AWS Application",
  • "modifiedOn": "2023-12-12T09",
  • "collection": "UserCart",
  • "_etag": {
    }
}

Response samples

Content type
application/json
{
  • "correlationId": "657820f1171a9761e416ee25",
  • "result": true
}

Task

Utilize 'Task' endpoints to retrieve, act upon, and comment on task details. Tasks include Completed, Expired, approval, and rejected types. Use the Fetch task endpoint to obtain task details with filter attributes. Perform actions like approve, reject, claim, release, escalate, and re-assign. Additionally, use provided endpoints to add comments to tasks.

Fetch

This Endpoint will give you the list of Tasks based on filters.

Authorizations:
jwt
query Parameters
filter
string

string with JSON object containing the filter attributes. For example, Completed tasks would have the JSON filter attribute {status:Completed,userLogin:user}. Expired Tasks would have the JSON filter {status:Expired,userLogin:user}. Similarly you can have the filters for completed approval and completed rejects tasks for a user

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Action

This endpoint will enable you to perform action on a task such as- approve, reject, claim, release, escalate and re-assign. In order to run the task, you will need the task object ID which you can get from the fetch task endpoint.

Fetch Task
Authorizations:
jwt
path Parameters
id
required
string

This is the task object id which you can get from the Fetch Task endpoint.

action
required
string
Enum: "Claim" "Approve" "Reject" "Escalate" "Re-Assign"
Example: Approve

You can perform different actions on a task depending on the workflow of the task. Different actions can be - Claim, Approve, Reject, Escalate, Re-Assign

Request Body schema: application/json

This is the task operation object which basically has the user login details and comment (if any)

userLogin
string
comment
string

Responses

Request samples

Content type
application/json
{
  • "userLogin": "string",
  • "comment": "string"
}

Response samples

Content type
application/json
{
  • "IDM": "IDE",
  • "_id": {
    },
  • "assignee": "zachary",
  • "assigneeType": "User",
  • "collection": "UserTask",
  • "createDate": "2023-12-18T11:31:26.166+0000",
  • "entityObject": {
    },
  • "expiry": 15,
  • "expiryDate": "2024-01-02T11:31:26.166+0000",
  • "history": {
    },
  • "name": "Manager Approval Task",
  • "outcome": "MANAGERAPPROVE",
  • "payload": {
    },
  • "possibleActions": null,
  • "requestId": "e4b07",
  • "requestJustification": "hhjh",
  • "requestObject": {
    },
  • "requestObjectId": "65802d8d994114206f6e6cf2",
  • "result": true,
  • "status": "Completed",
  • "title": "Buffer",
  • "type2": "ApprovalTask",
  • "updateDate": "2023-12-18T11:32:26.722+0000",
  • "updatedBy": "zachary",
  • "updatedByDisplayName": "Zachary Graham",
  • "updatedDate": "2023-12-18T11:32:26.728+0000",
  • "workflowName": "Manager and BO Grant and Auto Revoke"
}

Comment

This Endpoint allows you to Add attachment and comments to tasks.

Authorizations:
jwt
Request Body schema: multipart/form-data

The properties object is a JSON object which would contain the "taskId", "userLogin", "message", "filename". For Example "userLogin":"jerome","message":"test comment","taskId":"64f99c55a5ff95f7e0dddc26"

attachment
string
object

Responses

Response samples

Content type
application/json
{
  • "history": [
    ],
  • "expiryDate": "string",
  • "updateDate": "string",
  • "createDate": "string",
  • "outcome": "string",
  • "state": "Assigned",
  • "escalationAssignee": "string",
  • "form": { },
  • "payload": { },
  • "requestID": "string",
  • "possibleActions": [
    ],
  • "assigneeType": "user",
  • "assignee": "string",
  • "type": "ApprovalTask",
  • "description": "string",
  • "summary": "string",
  • "title": "string",
  • "name": "string",
  • "comments": [
    ]
}

UserAccount

You might want to see the details of a user account. Endpoint given under this section enables you to fetch the details of any user account. You can use the userid, login and status filter parameters in order to search and fetch the details of a user account.

Fetch

This Endpoint lets you get the user account. You would have to enter the login and userid as parameters to get the details of the user account.

Authorizations:
jwt
query Parameters
userid
string

Here you would have to enter the userid to get the user details

login
string

Here you would have to enter the user login details.

status
string

You can also use the status filer to further get more specific response based on the status. For example, the status can be "Provisioned"

Responses

Response samples

Content type
application/json
{
  • "_id": {
    },
  • "IDM": "IDE",
  • "associatedRoles": [
    ],
  • "collection": "UserAccount",
  • "entitlements": {
    },
  • "form": {
    },
  • "login": "steve",
  • "logoURL": "Logo.files/63aefd2f93ccdf675cc7509f/binary",
  • "provisionMechanism": "Role",
  • "provisionedDate": "2023-03-07T07:20:40.855+0000",
  • "status": "Provisioned",
  • "targetSystemId": "63aefd2f93ccdf675cc7509f",
  • "targetSystemName": "Salesforce",
  • "userId": "63aec79193ccdf675cc4cbbb"
}

Role

Endpoint under this section enables you to fetch the list of roles and their details.

Fetch All

This Endpoint lets you fetch the list of roles and their details. You can enter the display name of the role and page size as query filters.

Authorizations:
jwt
query Parameters
displayName
string

This is the display name of the role

pagesize
string

Here you can enter the page size. Page Size is a number.

Responses

Response samples

Content type
application/json
{
  • "performer": "jerome",
  • "riskLevel": "low",
  • "displayName": "All Employees",
  • "searchTags": "All Employees",
  • "description": "This Role is assigned to all Employees.",
  • "rule": "{\"$and\":[{\"status\":\"Active\"},{\"department\":{\"$nin\":[\"CO\"]}}]}",
  • "isCertifiable": true,
  • "collection": "Role",
  • "workflowRequestFormId": "88478478abjkhk9",
  • "createdOn": "2022-12-30T15:28:23.827Z",
  • "approvalWorkflowDisplayName": "Auto Role Approval",
  • "IDM": "IDE",
  • "roleOwnerLogin": "samantha",
  • "isRequestable": true,
  • "name": "All Employees",
  • "disabled": false,
  • "ruleForm": "{\"$and\":[{\"attribute\":\"status\",\"condition\":\"equals\",\"value\":\"Active\",\"options\":[\"Active\"]},{\"attribute\":\"department\",\"condition\":\"notin\",\"value\":[\"CO\"],\"options\":[\"CO\"]}]}",
  • "applications": {
    },
  • "id": {
    },
  • "approvalWorkflow": "Auto Role Approval"
}

Operation

This endpoint lets you do operation on the role. The operations can be Enable/Disable/Retire

Authorizations:
jwt
query Parameters
roleID
string
Example: roleID=63aed43793ccdf675cc58246

roleID of the role for which you want take the action. You can fetch the roleID using the search catalog endpoint.

operation
string
Enum: "Retire" "Enable" "Disable"
Example: operation=Retire

This is the operation that you want to take for the role. The operation can be, enable/disable/retire.

Responses

Response samples

Content type
application/json
{
  • "IDM": "IDE",
  • "_id": {
    },
  • "applications": {
    },
  • "approvalWorkflow": "Group Role Approval",
  • "approvalWorkflowDisplayName": "Group Role Approval",
  • "approver1": "Approval Group 2",
  • "approver2": "Approval Group 3",
  • "approver3": "CEO",
  • "collection": "Role",
  • "createdOn": "2022-12-30T15:35:47.633Z",
  • "description": "This Role is assigned to all Chief Officers.",
  • "disabled": true,
  • "displayName": "Chief Officer",
  • "isCertifiable": null,
  • "isRequestable": true,
  • "name": "Chief Officer",
  • "performer": null,
  • "retired": true,
  • "riskLevel": "high",
  • "roleOwnerLogin": "derrick",
  • "rule": "$and:[department:CO]",
  • "ruleForm": "$and:[attribute:departmentcondition:equalsvalue:COoptions:[CO]]",
  • "searchTags": "CXO Roles",
  • "workflowRequestFormId": "6085f65f432acc2a019f1fbe"
}

Application

Endpoint under this section enables you to fetch the list of applications and their details.

Fetch All

This Endpoint lets you fetch the list of application and their details. You can enter the display name of the application and page size as query filters.

Authorizations:
jwt
query Parameters
displayName
string

This is the display name of the application

pagesize
string

Here you can enter the page size. Page Size is a number.

Responses

Response samples

Content type
application/json
{
  • "performer": "Manual Fulfiller",
  • "riskLevel": "medium",
  • "displayName": "Zendesk",
  • "searchTags": "IT",
  • "description": "Custom Support Tracking System",
  • "collection": "TargetSystem",
  • "createdOn": "2022-12-30T12:06:15.174Z",
  • "approvalWorkflowDisplayName": "Group Approval",
  • "IDM": "IDE",
  • "form": {
    },
  • "integrationLevel": "integrationLevel",
  • "logoURL": "Logo.files/63af022493ccdf675cc795e1/binary",
  • "trustedReconciliation": false,
  • "workflowRequestFormId": "6085f65f432acc2a019f1fbe",
  • "schedule": {
    },
  • "isRequestable": true,
  • "name": "Zendesk",
  • "disabled": false,
  • "id": {
    },
  • "approvalWorkflow": "Group Approval",
  • "businessOwner": "liz",
  • "targetSystemDisplayName": "ADP",
  • "ITOwner": "jerome",
  • "applicationURL": "https://www.zendesk.com/",
  • "approver1": "Approval Group 2",
  • "approver2": "Approval Group 3",
  • "approver3": "CEO"
}

Reconciliation By ID

This endpoint enables you to do the application reconciliation

Authorizations:
jwt
path Parameters
id
required
string

entityID of the application for which you want to run the re-conciliation. You can filter the appropriate entity using the entityID and you can search for the same using the search catalog endpoint

Request Body schema: application/json
condition
string

This will update IDHub if any mismatch is found.

operation
string
Enum: "reconcile" "provision"

If you want to reconcile your data from the target system, then this should be reconcile and if you want to provision accounts then you need to enter provision here

entityType
string
Enum: "Account" "Entitlement"

Entity type can be either accounts or entitlements depending on whether you are reconciling accounts or entitlements for the recon operation

Responses

Request samples

Content type
application/json
{
  • "condition": "string",
  • "operation": "reconcile",
  • "entityType": "Account"
}

Response samples

Content type
application/json
{
  • "targetSystemId": "64ad77dafdfcc6b382aeaceb",
  • "targetSystemName": "EntraID",
  • "tenantName": "vc3",
  • "resourceType": "account",
  • "startDate": "2023-12-13T10:39:06.650Z",
  • "status": "Initiated",
  • "collection": "ReconciliationBatch",
  • "dryRun": false,
  • "IDM": "IDE",
  • "_etag": {
    },
  • "_id": {
    },
  • "targetSystem": {
    },
  • "_meta": {
    }
}

Fetch past Recon Events

This endpoint enables you to view the application recon events

Authorizations:
jwt
query Parameters
object

This is the Recon Batch ID

resourceType
string
Example: resourceType=User

This is the resourceType for the recon events.

Responses

Response samples

Content type
application/json
{
  • "_id": {
    },
  • "_etag": {
    },
  • "IDM": "IDE",
  • "collection": "ReconciliationEvent",
  • "createDate": "2023-12-13T10:40:00.872Z",
  • "eventType": "TargetSystemAccount",
  • "lastModified": "2023-12-13T10:40:00.872Z",
  • "reconciliationBatchId": {
    },
  • "resourceType": "User",
  • "rowNumber": 42,
  • "status": "EXISTING_USER_ACCOUNT_RECONCILED_NO_CHANGE",
  • "tenant": "vc3",
  • "numberOfEntitlements": 1,
  • "resourceDisplayName": "Zachary Graham",
  • "resourceFromTargetSystem": {
    },
  • "resourceId": "d9c7200a-3322-4035-9e7b-03974624d4f7",
  • "resourceInIdhubBeforeModification": {
    },
  • "userAccountBeforeModification": {
    }
}

Operation

This endpoint enables you to do operation on application. The operations can be Enable/Disable/Retire

Authorizations:
jwt
query Parameters
targetsystemID
string
Example: targetsystemID=63aed43793ccdf675cc58246

targetsystemID of the application for which you want take the action. You can fetch the targetsystemID using the search catalog endpoint.

operation
string
Enum: "Retire" "Enable" "Disable"
Example: operation=Retire

This is the operation that you want to take for the application. The operation can be, enable/disable/retire.

Responses

Response samples

Content type
application/json
{
  • "IDM": "IDE",
  • "ITOwner": "michael",
  • "_id": {
    },
  • "applicationURL": "https://www.adp.com/",
  • "approvalWorkflow": "Manager Grant and Auto Revoke",
  • "approvalWorkflowDisplayName": "Manager Grant and Auto Revoke",
  • "businessOwner": "liz",
  • "collection": "TargetSystem",
  • "createdOn": "2022-12-30T12:06:15.145Z",
  • "description": "HR and Payroll Use",
  • "disabled": true,
  • "displayName": "ADP",
  • "form": {
    },
  • "integrationLevel": "Disconnected",
  • "isRequestable": true,
  • "logoURL": "Logo.files/63aed43793ccdf675cc58246/binary",
  • "name": "ADP",
  • "performer": "Manual Fulfiller",
  • "retired": true,
  • "riskLevel": "low",
  • "schedule": {
    },
  • "searchTags": "All Employees HR",
  • "trustedReconciliation": true
}

Certification

Endpoints under this section enables you to create a certification and run the certificate.

Fetch

This endpoint enables you to fetch the list of certifications for your tenant

Authorizations:
jwt
query Parameters
status
string
Enum: "Active" "Draft"
Example: status=Active

This is the status of the certificate, which can be either Active or Draft

pagesize
string

Here you can enter the page size. Page Size is a number.

Responses

Response samples

Content type
application/json
{
  • "_id": {
    },
  • "_etag": {
    },
  • "altCertifyUser": {
    },
  • "alternateCertifier": "jerome",
  • "alternateCertifierRole": null,
  • "alternateCertifierToggle": "user",
  • "alternateCertifierType": "User",
  • "alternateCertifierUser": "Jerome Fern",
  • "approverType": "none",
  • "automaticEscalation": true,
  • "certificationBy": "manually",
  • "certificationDuration": 1,
  • "certificationDurationType": "days",
  • "certificationReminderEmail": true,
  • "certifier": "jerome",
  • "certifierDisplayName": "Jerome Fern",
  • "certifierToggle": "user",
  • "certifierType": "User",
  • "certifyUser": {
    },
  • "commentsOnCertify": true,
  • "commentsOnRevoke": true,
  • "createdBy": "jerome",
  • "createdByDisplayName": "Jerome Fern",
  • "createdOn2": "2023-08-01T07:23:53.600Z",
  • "description": "This is test atlassian certification",
  • "displayUserQuery": "$and:[attribute:statuscondition:equalsvalue:Activeoptions:[ActiveDisabled]]",
  • "frequentlyUsedRule": {
    },
  • "highRiskResources": true,
  • "highRiskUsers": true,
  • "name": "Atlassian",
  • "onlySelected": true,
  • "reassignment": true,
  • "repeat": "Do not repeat",
  • "resourceQuery": "$or:[_id:$oid:64c8a5aefdfcc6b382d82cb2collection:Entitlement_id:$oid:64c8a4ddfdfcc6b382d82267collection:Entitlement_id:$oid:64c8a5aefdfcc6b382d82ccfcollection:Entitlement_id:$oid:64c8a5aefdfcc6b382d82ceccollection:Entitlement_id:$oid:64c8a5aefdfcc6b382d82d0ccollection:Entitlement_id:$oid:64c89886fdfcc6b382d7814ecollection:TargetSystem]",
  • "resources": null,
  • "searchTags": "Atlassian",
  • "selfCertification": true,
  • "status2": "Active",
  • "triggerCondition": null,
  • "type2": "User Access",
  • "userCertificationBy": "query",
  • "userQuery": "$and:[status:Active]",
  • "workflowDescription": "Default Certification Workflow",
  • "workflowName": "Certification"
}

Create

This endpoint enables you to create the certificate definition.

Authorizations:
jwt
Request Body schema: application/json
name
required
string non-empty

This is the certificate definition name

searchTags
string
description
required
string non-empty

This is the description of the certificate that you are creating

type
required
string non-empty
Enum: "User Access" "Resource Assignment"

This is the type of the certificate that you want to create. Certificate definition can be of either User Access or Resource Assignement.

approverType
required
string non-empty
Enum: "User" "Role" "None"

This is the Approval workflow for the certificate definition, which can be either User (a specific individual), Role or none.

workflowName
required
string non-empty

This is the worfklow for the certificate. By Default, IDHub provides a workflow for the certificate definition. If you have your own custom workflow for the certificate then you can use that as well.

workflowDescription
string
approver
string
object

If the approverType is User, then here you have to enter the entityID of the user, who will approve the certification.

status
string
highRiskUsers
boolean
userCertificationBy
required
string non-empty
Enum: "query" "name"

Here you select the users for the certificate. You can select the users by either query or the name of the user

userQuery
string
displayUserQuery
string
highRiskResources
boolean
certificationBy
string
onlySelected
boolean
resourceQuery
string
object

This is where you select the resources for the certification. Here you have to enter the entityID of the resource, which you can fetch from the search catalog endpoint.

certifierType
required
string non-empty
Enum: "User" "Role" "Benefeciary's Manager" "Resource owner"

Here you have to select the certifier for the certificate. The certifier can be individual user, role, benefeciary's manager or resource owner.

certifier
string
certifierDisplayName
string
certifierToggle
string
repeat
required
string non-empty

This is if you want to repeat the certificate run

object

Here you have to specify the entityID of the user, if the certifierType is user. You can fetch the entityID from the search catalog.

commentsOnCertify
boolean
commentsOnRevoke
boolean
reassignment
boolean
selfCertification
boolean
automaticEscalation
boolean
certificationReminderEmail
boolean
alternateCertifierToggle
string
alternateCertifierUser
string
alternateCertifierRole
string
alternateCertifierType
string
alternateCertifier
required
string non-empty
Enum: "User's Manager" "Role" "User"

This is the alternate certififer for the certificate definition. By default, the alternate certifier is the user's manager.

triggerCondition
string
object
certificationDurationType
string non-empty
Enum: "days" "months" "years"

Here you specify the duration of the certificate

certificationDuration
string
required
object
createdBy
string
createdOn
string <date-time>
createdByDisplayName
string

Responses

Request samples

Content type
application/json
{
  • "name": "myCert",
  • "searchTags": null,
  • "description": "myCert",
  • "type": "User Access",
  • "approverType": "User",
  • "workflowName": "Certification",
  • "workflowDescription": "Default Certification Workflow",
  • "approver": "jerome",
  • "workflowUser": {
    },
  • "status": "Active",
  • "highRiskUsers": true,
  • "userCertificationBy": "query",
  • "userQuery": "$and:[status:Active]",
  • "displayUserQuery": "$and:[attribute:statuscondition:equalsvalue:Activeoptions:[ActiveDisabled]]",
  • "highRiskResources": true,
  • "certificationBy": "manually",
  • "onlySelected": true,
  • "resourceQuery": "$or:[_id:$oid:63aec1a88773337a0e61405acollection:Role]",
  • "resources": {
    },
  • "certifierType": "User",
  • "certifier": "jerome",
  • "certifierDisplayName": "Jerome Fern",
  • "certifierToggle": "user",
  • "repeat": "Do not repeat",
  • "certifyUser": {
    },
  • "commentsOnCertify": true,
  • "commentsOnRevoke": true,
  • "reassignment": true,
  • "selfCertification": true,
  • "automaticEscalation": true,
  • "certificationReminderEmail": true,
  • "alternateCertifierToggle": "manager",
  • "alternateCertifierUser": null,
  • "alternateCertifierRole": null,
  • "alternateCertifierType": null,
  • "alternateCertifier": "$manager",
  • "triggerCondition": null,
  • "frequentlyUsedRule": {
    },
  • "certificationDurationType": "days",
  • "certificationDuration": 1,
  • "_id": {
    },
  • "createdBy": "jerome",
  • "createdOn": "2023-12-15T10:13:03.408Z",
  • "createdByDisplayName": "Jerome Fern"
}

Response samples

Content type
application/json
true

Run

This endpoint enables you to run the certificate. You will need the cert definition ID to run the certificate, which you can get from the fetch certificate endpoint.

Fetch Certificate
Authorizations:
jwt
path Parameters
id
string
Example: 63aed43793ccdf675cc58246

This is the certificate definition ID of the certificate that you want to run.

Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "impactObject": {
    },
  • "requester": {
    }
}

Response samples

Content type
application/json
true

Shared Lists

You might want to fetch the lists that you have shared with another user or get the lists that has been shared to you by another user. Endpoints allows you to get those lists and their details.

Fetch

This Endpoint lets you get the Shared Lists. You can use sharedBy filter parameter to get the lists shared by the user and you can use sharedWith filter parameter in order to get the lists shared with the current user by another user.

Authorizations:
jwt
query Parameters
filter
string

Use the sharedBy filter to get the lists shared by the user. For instance {"sharedBy":"jerome"}. Similarly use the sharedWith filter to get the lists shared with the user by another user.

Responses

Response samples

Content type
application/json
{
  • "_etag": {
    },
  • "_id": {
    },
  • "cartItems": {
    },
  • "collection": "UserCart",
  • "name": "MyList",
  • "owner": "User/63aec79793ccdf675cc4d018",
  • "requester": {
    },
  • "user": {
    }
}

OnBoard

Endpoints under this section lets you on-board applications and roles

Create Application / Role

Authorizations:
jwt
Request Body schema: application/json
entityType
string

Type of Entity

IDM
string
justification
required
string non-empty

This is the justification that you have enter for on-boarding this application

requestType
string
summary
string
status
string
createDate
string <date-time>
required
object non-empty

This is the requester object and contains the details of the requester like requester email and login

required
object non-empty

This is the payload object which is used to on-board the application.

collection
string
resolution
string
object

Responses

Request samples

Content type
application/json
Example
{
  • "entityType": "Application",
  • "IDM": "IDE",
  • "justification": "creating application",
  • "requestType": "Catalog",
  • "summary": "New Application Request - testag",
  • "status": "Draft",
  • "createDate": "2023-12-18T13:21:11.421Z",
  • "requester": {
    },
  • "payload": {
    },
  • "collection": "UserRequest",
  • "resolution": "Initiated",
  • "_id": {
    }
}

Response samples

Content type
application/json
true