Approvals API (2.17.0)

Download OpenAPI specification:Download

ILM: info@otilm.com URL: https://www.otilm.com License: MIT License

REST API for approvals in the platform

ILM Documentation

Approval profile Inventory

Approval profile Inventory API

Get Approval Profile Details

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval profile UUID

query Parameters

version

integer <int32>

Responses

Response samples

200
400
403
404

Content type

application/json

{"uuid": "string",
"name": "ApprovalProfile1",
"version": 1,
"description": "Detail description of the approval profile",
"expiry": 24,
"numberOfSteps": 2,
"associations": 0,
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"username": "string",
"roleName": "string",
"groupName": "string"
}
]
}

Edit an Approval profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval profile UUID

Request Body schema: application/json
required

description	string Description of the Approval profile
expiry	integer <int32> Expiration of the Approval profile in hours
required	Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile

Responses

Request samples

Payload

Content type

application/json

{"description": "Detail description of the approval profile",
"expiry": 24,
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "string"
}

Delete an approval profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval profile UUID

Responses

Response samples

400
403
404
422

Content type

application/json

{"message": "Error message"
}

List Approval Profiles

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403
404

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvalProfiles": [{"uuid": "string",
"name": "ApprovalProfile1",
"version": 1,
"description": "Detail description of the approval profile",
"expiry": 24,
"numberOfSteps": 2,
"associations": 0
}
]
}

Create a Approval profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

Request Body schema: application/json
required

name required	string Name of the Approval profile
description	string Description of the Approval profile
enabled required	boolean Enable of the Approval profile
expiry	integer <int32> Expiration of the Approval profile in hours
required	Array of objects (ApprovalStepRequestDto) List of Approval steps for the Approval profile

Responses

Request samples

Payload

Content type

application/json

{"name": "ApprovalProfile1",
"description": "Detail description of the approval profile",
"enabled": true,
"expiry": 24,
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0
}
]
}

Response samples

200
400
403
404
422

Content type

application/json

{"uuid": "string"
}

Disassociate Approval Profile from specified resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string <uuid> Approval Profile UUID
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Example: raProfiles Resource
associationObjectUuid required	string <uuid> Association object UUID

Responses

Associate Approval Profile to specified resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid required	string <uuid> Approval Profile UUID
resource required	string (Resource) Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets" Example: raProfiles Resource
associationObjectUuid required	string <uuid> Association object UUID

Responses

Response samples

422

Content type

*/*

[
  "Error Message 1",
  "Error Message 2"
]

Get associations of Approval Profile

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string <uuid>

Approval Profile UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"resource": "NONE",
"objectUuid": "2dcc528b-9e16-46c6-877e-74eae258173f",
"name": "Name"
}
]

Get associated Approval Profiles for resource object

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

resource

required

string (Resource)

Enum: "NONE" "ANY" "dashboard" "settings" "auditLogs" "credentials" "connectors" "attributes" "jobs" "users" "roles" "acmeAccounts" "acmeProfiles" "cboms" "scepProfiles" "cmpProfiles" "authorities" "raProfiles" "certificates" "certificateRequests" "groups" "complianceProfiles" "discoveries" "oids" "entities" "locations" "tokenProfiles" "tokens" "keys" "approvalProfiles" "approvals" "notificationProfiles" "notificationInstances" "rules" "actions" "triggers" "resources" "resourceEvents" "searchFilters" "keyItems" "platformEnums" "notifications" "conditions" "executions" "complianceRules" "complianceGroups" "customAttributes" "globalMetadata" "acmeOrders" "acmeAuthorizations" "acmeChallenges" "cmpTransactions" "endEntityProfiles" "authenticationProviders" "vaults" "vaultProfiles" "secrets"

Example: raProfiles

Resource

associationObjectUuid

required

string <uuid>

Association object UUID

Responses

Response samples

200
400
403
404

Content type

application/json

[{"uuid": "string",
"name": "ApprovalProfile1",
"version": 1,
"description": "Detail description of the approval profile",
"expiry": 24,
"numberOfSteps": 2,
"associations": 0
}
]

Approval Inventory

Approval Inventory API

Rejecting of the Approval

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval UUID

Responses

Rejecting of Recipient of the Approval

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval UUID

Request Body schema: application/json
required

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

Approving of the Approval

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval UUID

Responses

Approving of Recipient of the Approval

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval UUID

Request Body schema: application/json
required

comment

string

Responses

Request samples

Payload

Content type

application/json

{"comment": "string"
}

List of Approvals

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvals": [{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string"
}
]
}

Get Approval Detail

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

path Parameters

uuid

required

string

Approval UUID

Responses

Response samples

200
400
403
404

Content type

application/json

{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string",
"expiry": 0,
"description": "string",
"approvalSteps": [{"userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826",
"roleUuid": "e343d0c5-cc56-4f04-bed4-3ed344d37f3b",
"groupUuid": "71fee78a-8074-4708-b2ba-44fae6164fac",
"description": "string",
"order": 0,
"requiredApprovals": 0,
"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"username": "string",
"roleName": "string",
"groupName": "string",
"approvalStepRecipients": [{"approvalRecipientUuid": "string",
"userUuid": "string",
"username": "string",
"createdAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"comment": "string"
}
]
}
]
}

List of User's Approvals

Authorizations:

BearerJWTAuthCertificateAuthSessionAuth

query Parameters

itemsPerPage	integer <int32> <= 1000 Default: 10 Number of entries per page
pageNumber	integer <int32> Default: 1 Page number for the request
history	boolean

Responses

Response samples

200
400
403

Content type

application/json

{"itemsPerPage": 0,
"pageNumber": 0,
"totalPages": 0,
"totalItems": 0,
"approvals": [{"approvalUuid": "string",
"creatorUuid": "string",
"creatorUsername": "string",
"version": 0,
"createdAt": "2019-08-24T14:15:22Z",
"expiryAt": "2019-08-24T14:15:22Z",
"closedAt": "2019-08-24T14:15:22Z",
"status": "PENDING",
"resource": "NONE",
"resourceAction": "string",
"objectUuid": "string",
"approvalProfileName": "string",
"approvalProfileUuid": "string"
}
]
}

Approvals API (2.17.0)

Approval profile Inventory

Get Approval Profile Details

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Edit an Approval profile

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an approval profile

Authorizations:

path Parameters

Responses

Response samples

List Approval Profiles

Authorizations:

query Parameters

Responses

Response samples

Create a Approval profile

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Disassociate Approval Profile from specified resource object

Authorizations:

path Parameters

Responses

Associate Approval Profile to specified resource object

Authorizations:

path Parameters

Responses

Response samples

Get associations of Approval Profile

Authorizations:

path Parameters

Responses

Response samples

Get associated Approval Profiles for resource object

Authorizations:

path Parameters

Responses

Response samples

Approval Inventory

Rejecting of the Approval

Authorizations:

path Parameters

Responses

Rejecting of Recipient of the Approval

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Approving of the Approval

Authorizations:

path Parameters

Responses

Approving of Recipient of the Approval

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

List of Approvals

Authorizations:

query Parameters

Responses

Response samples

Get Approval Detail

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required