{"info":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","description":"<html><head></head><body><p>This collection provides details on the supported methods for the Lifecycle Management (LCM) API for AI agent governance, including agent search, label management, multi-owner assignment, and automated ownership succession.</p>\n<h2 id=\"accessing-the-api\">Accessing the API</h2>\n<p>The URL for Identity Security for AI APIs is in the following format:</p>\n<p><code>{{url}}/{{path}}/apiName</code></p>\n<p>Where:</p>\n<ul>\n<li><p><code>{{url}}</code>: The Saviynt Identity Cloud application URL</p>\n</li>\n<li><p><code>{{path}}</code>: The Identity Security for AI REST API version 1.0.</p>\n</li>\n<li><p><code>apiName</code>: The API endpoint name.</p>\n</li>\n</ul>\n<p>For example: <a href=\"https://myorg.saviyntcloud.com/ispm/v1/identity\">https://myorg.saviyntcloud.com/api/v2/agents</a></p>\n<h2 id=\"setting-variables\">Setting Variables</h2>\n<p>Set the <code>{{url}}</code> variables to match your Saviynt Identity Cloud application URL in the following format: <a href=\"https://SUBDOMAIN.saviyntcloud.com\">https://SUBDOMAIN.saviyntcloud.com</a></p>\n<p>For example: <a href=\"https://myorg.saviyntcloud.com\">https://myorg.saviyntcloud.com</a></p>\n</body></html>","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"51302526","collectionId":"ff735f62-0277-4396-9735-6a314066188a","publishedId":"2sBXijKsGz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2026-03-24T09:31:42.000Z"},"item":[{"name":"1.0 Authentication","item":[{"name":"Get Authorization Token","event":[{"listen":"test","script":{"id":"64b79d28-1559-4be4-9003-7f52564ba7cd","exec":[""],"type":"text/javascript","packages":{}}}],"id":"c6a1c1cf-6fe6-4578-a743-f0248c324f37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"username\": \"<username>\",\r\n    \"password\": \"<password>\"\r\n}"},"url":"{{url}}/ECM/api/login","description":"<p>Use this API to obtain an authentication token.</p>\n<p>The API requires the HTTP authentication scheme <code>Bearer</code> for authentication. All requests must have a valid <code>Token</code> specified in the HTTP Authorization header with the <code>Bearer</code> scheme.</p>\n<p><strong>Mandatory Parameters</strong></p>\n<ul>\n<li><p><code>username</code>: Specify the user name to log in to Saviynt Identity Cloud.</p>\n</li>\n<li><p><code>password</code>: Specify the password to log in to Saviynt Identity Cloud.</p>\n</li>\n</ul>\n<p>A POST request, in which the <code>username</code> and <code>password</code> are passed in JSON text in the body, will return a <code>Token</code> in the response, which can be passed in a header variable for subsequent requests.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["ECM","api","login"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"be2ffd39-f2cd-478a-adb2-2da66cc15989","name":"Get Authorization Token","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n    \"username\": \"<username>\",\r\n    \"password\": \"<password>\"\r\n}"},"url":"{{url}}/ECMv6/api/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n  \"username\": \"admin\",\r\n  \"roles\": [\r\n    \"ROLE_ADMIN\"\r\n  ],\r\n  \"token_type\": \"Bearer\",\r\n  \"access_token\": \"eyJhbGcixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxOiJIUzI1NiJ98\",\r\n  \"expires_in\": 3600,\r\n  \"refresh_token\": \"eyJhbGciOiJIUzI1NixxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxF0sn2e3w\"\r\n}"}],"_postman_id":"c6a1c1cf-6fe6-4578-a743-f0248c324f37"}],"id":"5cc1b4a3-4205-4eb2-bf0a-fdfc4a0856b3","_postman_id":"5cc1b4a3-4205-4eb2-bf0a-fdfc4a0856b3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}}},{"name":"2.0 Agent Management","item":[{"name":"Search & Filter Agents","id":"bbffce60-27ed-469c-924d-5bae2d2747b3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"searchQuery\": \"access review\",\n  \"filters\": {\n    \"agentIds\": [\"agent-abc\"],\n    \"cloudPlatforms\": [\"AWS\", \"GCP\"],\n    \"frameworks\": [\"Bedrock Agents\", \"Vertex AI\"],\n    \"llmModels\": [\"gpt-4o\"],\n    \"labels\": [\"risk_level:High\", \"compliance_scope:SOX\"],\n    \"criticality\": [\"high\", \"critical\"],\n    \"ownerIds\": [\"dsmith@example.com\"],\n    \"status\": [\"active\"],\n    \"source\": [\"API\"]\n  },\n  \"sort\": {\n    \"field\": \"lastUsedAt\",\n    \"direction\": \"desc\"\n  },\n  \"pagination\": {\n    \"page\": 1,\n    \"limit\": 25\n  }\n}"},"url":"{{url}}/api/v2/agents/search","description":"<p>Use this API to search and filter agents.</p>\n<p><strong>Filter semantics</strong></p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Filter</strong></th>\n<th><strong>Type</strong></th>\n<th><strong>Behaviour</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>searchQuery</td>\n<td><code>string</code></td>\n<td>Full-text match on displayName, name, description (GIN index)</td>\n</tr>\n<tr>\n<td>labels</td>\n<td><code>string[]</code></td>\n<td>Format \"key:value\" — uses JSONB @&gt; containment. Multiple labels are AND'd</td>\n</tr>\n<tr>\n<td>All other arrays</td>\n<td></td>\n<td>OR within field, AND across fields</td>\n</tr>\n<tr>\n<td>sort.field</td>\n<td><code>string</code></td>\n<td>lastUsedAt (default)</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","search"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"47c26033-b5f4-4f95-a2f4-84f6b962ccde","name":"Search & Filter Agents","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"searchQuery\": \"access review\",\n  \"filters\": {\n    \"agentIds\": [\"agent-abc\"],\n    \"cloudPlatforms\": [\"AWS\", \"GCP\"],\n    \"frameworks\": [\"Bedrock Agents\", \"Vertex AI\"],\n    \"llmModels\": [\"gpt-4o\"],\n    \"labels\": [\"risk_level:High\", \"compliance_scope:SOX\"],\n    \"criticality\": [\"high\", \"critical\"],\n    \"ownerIds\": [\"dsmith@example.com\"],\n    \"status\": [\"active\"],\n    \"source\": [\"API\"]\n  },\n  \"sort\": {\n    \"field\": \"lastUsedAt\",\n    \"direction\": \"desc\"\n  },\n  \"pagination\": {\n    \"page\": 1,\n    \"limit\": 25\n  }\n}"},"url":"https://your-instance.example.com/api/v2/agents/search"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n  \"data\": [\r\n    {\r\n      \"agentId\": \"agent-c8f5d4ce-...\",\r\n      \"displayName\": \"AccessReview-Bot\",\r\n      \"name\": \"AccessReview-Bot\",\r\n      \"url\": \"https://agent.example.com\",\r\n      \"cloudPlatform\": \"AWS\",\r\n      \"framework\": \"Bedrock Agents\",\r\n      \"criticality\": \"high\",\r\n      \"criticalityOverride\": false,\r\n      \"status\": \"active\",\r\n      \"source\": \"API\",\r\n      \"agentMetadata\": {\r\n        \"model\": \"gpt-4o\"\r\n      },\r\n      \"primaryOwner\": {\r\n        \"ownerName\": \"Daniel Smith\",\r\n        \"ownerContact\": \"dsmith@example.com\",\r\n        \"ownerRole\": \"Business Owner\",\r\n        \"rank\": 1,\r\n        \"terminated\": false\r\n      },\r\n      \"additionalOwnerCount\": 2,\r\n      \"labelCount\": 6,\r\n      \"lastUsedAt\": \"2026-01-24T11:24:00Z\"\r\n    }\r\n  ],\r\n  \"pagination\": {\r\n    \"page\": 1,\r\n    \"limit\": 25,\r\n    \"totalCount\": 142,\r\n    \"hasNextPage\": true\r\n  }\r\n}"}],"_postman_id":"bbffce60-27ed-469c-924d-5bae2d2747b3"},{"name":"Get Filter Dropdown Values","id":"abf3d8e5-20ca-425a-8176-b97f0df119d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"target\": \"llmModels\",\n  \"targetKey\": null,\n  \"searchQuery\": \"gpt\",\n  \"filters\": {\n    \"cloudPlatforms\": [\"AWS\"]\n  },\n  \"pagination\": {\n    \"page\": 1,\n    \"limit\": 20\n  }\n}"},"url":"{{url}}/api/v2/agents/filter-options","description":"<p>Use this API to return distinct values and counts for a single filter dimension. Used to populate filter dropdowns in the UI.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>target</td>\n<td>agentIds  <br />cloudPlatforms  <br />frameworks  <br />llmModels  <br />labels  <br />criticality  <br />ownerIds  <br />status  <br />source</td>\n<td>required</td>\n</tr>\n<tr>\n<td>targetKey</td>\n<td>Required when target = \"labels\" — the normalised key to enumerate values for</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>searchQuery</td>\n<td>Substring filter on returned values</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>filters</td>\n<td>Context filters — narrows counts to matching agents</td>\n<td>optional</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","filter-options"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"cd727be3-446f-4e95-9671-cb75a5f3ed3f","name":"Get Filter Dropdown Values","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"target\": \"llmModels\",\n  \"targetKey\": null,\n  \"searchQuery\": \"gpt\",\n  \"filters\": {\n    \"cloudPlatforms\": [\"AWS\"]\n  },\n  \"pagination\": {\n    \"page\": 1,\n    \"limit\": 20\n  }\n}"},"url":"{{url}}/api/v2/agents/filter-options"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n  \"target\": \"llmModels\",\r\n  \"options\": [\r\n    {\r\n      \"value\": \"gpt-4o\",\r\n      \"label\": \"gpt-4o\",\r\n      \"count\": 12\r\n    },\r\n    {\r\n      \"value\": \"gemini-1.5-pro\",\r\n      \"label\": \"gemini-1.5-pro\",\r\n      \"count\": 8\r\n    }\r\n  ],\r\n  \"pagination\": {\r\n    \"totalCount\": 8,\r\n    \"hasNextPage\": false\r\n  }\r\n}"}],"_postman_id":"abf3d8e5-20ca-425a-8176-b97f0df119d3"},{"name":"Get Agent Detail","id":"35397982-ff3b-4c30-b7ae-017719eb536c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/v2/agents/<agentId>","description":"<p>Use this API to return the full agent object, including all owners (enriched with the terminated flag from identity_events) and all labels.</p>\n<p><strong>Mandatory URL Parameter</strong></p>\n<p><strong>agentId</strong>: Specify the Agent UUID. For example: <code>agent-c8f5d4ce-0235-4009-ac1e-8f2f8df8ec62</code></p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"611c35b9-979d-4cfe-81a4-e914501d6653","name":"Get Agent Detail","originalRequest":{"method":"GET","header":[],"url":"{{url}}/api/v2/agents/<agentId>"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n  \"agentId\": \"agent-c8f5d4ce-...\",\r\n  \"name\": \"AccessReview-Bot\",\r\n  \"displayName\": \"AccessReview-Bot\",\r\n  \"url\": \"https://agent.example.com\",\r\n  \"source\": \"API\",\r\n  \"status\": \"active\",\r\n  \"environment\": \"prod\",\r\n  \"agentType\": \"assistant\",\r\n  \"cloudPlatform\": \"AWS\",\r\n  \"framework\": \"Bedrock Agents\",\r\n  \"criticality\": \"high\",\r\n  \"criticalityOverride\": false,\r\n  \"agentMetadata\": {\r\n    \"model\": \"gpt-4o\",\r\n    \"temperature\": 0.7,\r\n    \"instructionPrompt\": \"...\"\r\n  },\r\n  \"owners\": [\r\n    {\r\n      \"ownerId\": 15,\r\n      \"ownerName\": \"Daniel Smith\",\r\n      \"ownerContact\": \"dsmith@example.com\",\r\n      \"ownerRole\": \"Business Owner\",\r\n      \"ownerType\": \"User\",\r\n      \"source\": \"Manual\",\r\n      \"rank\": 1,\r\n      \"terminated\": false\r\n    },\r\n    {\r\n      \"ownerId\": 16,\r\n      \"ownerName\": \"Shelley Greene\",\r\n      \"ownerContact\": \"sgreene@example.com\",\r\n      \"ownerRole\": \"Business Owner\",\r\n      \"ownerType\": \"User\",\r\n      \"source\": \"Policy\",\r\n      \"rank\": 2,\r\n      \"terminated\": true\r\n    }\r\n  ],\r\n  \"labels\": {\r\n    \"risk_level\": \"High\",\r\n    \"compliance_scope\": \"SOX\",\r\n    \"lifecycle_stage\": \"Development\"\r\n  },\r\n  \"lastUsedAt\": \"2026-01-24T11:24:00Z\",\r\n  \"createdAt\": \"2026-01-01T09:00:00Z\",\r\n  \"updatedAt\": \"2026-02-10T09:15:00Z\"\r\n}"}],"_postman_id":"35397982-ff3b-4c30-b7ae-017719eb536c"},{"name":"Register Agent","id":"4cb9067c-654b-462c-ae83-a0aa0b0ea91c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"HR-Onboarding-Bot\",\n  \"displayName\": \"New HR Agent\",\n  \"url\": \"https://agent-hr.example.com\",\n  \"environment\": \"prod\",\n  \"agentType\": \"assistant\",\n  \"cloudPlatform\": \"GCP\",\n  \"framework\": \"Vertex AI\",\n  \"agentMetadata\": {\n    \"model\": \"gemini-1.5-pro\",\n    \"temperature\": 0.5\n  },\n  \"rank1BusinessOwnerUserNames\": \"John Doe\",\n  \"rank1BusinessOwnerEmails\": \"john@example.com\",\n  \"rank1TechnicalOwnerUserNames\": \"Clark Kent\",\n  \"rank1TechnicalOwnerEmails\": \"bob@example.com\",\n  \"labels\": {\n    \"Business Function\": \"HR\",\n    \"compliance_scope\": \"SOX\"\n  }\n}"},"url":"{{url}}/api/v2/agents","description":"<p>Use this API to create a new agent record in pending status. Asynchronously triggers Policy Engine evaluation and automatically calculates criticality based on submitted owners.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>name</td>\n<td>System name, max 100 chars, unique within tenant</td>\n<td>required</td>\n</tr>\n<tr>\n<td>url</td>\n<td>Agent endpoint URL, max 255 chars</td>\n<td>required</td>\n</tr>\n<tr>\n<td>environment</td>\n<td>dev  <br />test  <br />staging  <br />prod</td>\n<td>required</td>\n</tr>\n<tr>\n<td>agentMetadata</td>\n<td>JSON object. Include <code>model</code>, <code>temperature</code>, <code>instructionPrompt</code></td>\n<td>required</td>\n</tr>\n<tr>\n<td>displayName</td>\n<td>Human-readable UI label</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>source</td>\n<td>API (default)  <br />CONNECTOR</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>agentType</td>\n<td>assistant  <br />conversational  <br />autonomous</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>cloudPlatform</td>\n<td>AWS  <br />GCP  <br />Azure</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>framework</td>\n<td>Bedrock Agents, Vertex AI, AWS AgentCore, OpenAI, and so on.</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>rank1BusinessOwnerUserNames</td>\n<td>Primary business owner name (rank 1–3 × Business/Technical)</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>rank1BusinessOwnerEmails</td>\n<td>Primary business owner email</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>labels</td>\n<td>Key–value object. Keys normalised: lowercase, spaces→underscores. Values: <code>[a-zA-Z0-9_-]</code> only</td>\n<td>optional</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"8f9e83f0-d43f-4495-9ebb-22aeea000e48","name":"Register Agent","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"name\": \"HR-Onboarding-Bot\",\n  \"displayName\": \"New HR Agent\",\n  \"url\": \"https://agent-hr.example.com\",\n  \"environment\": \"prod\",\n  \"agentType\": \"assistant\",\n  \"cloudPlatform\": \"GCP\",\n  \"framework\": \"Vertex AI\",\n  \"agentMetadata\": {\n    \"model\": \"gemini-1.5-pro\",\n    \"temperature\": 0.5\n  },\n  \"rank1BusinessOwnerUserNames\": \"John Doe\",\n  \"rank1BusinessOwnerEmails\": \"john@example.com\",\n  \"rank1TechnicalOwnerUserNames\": \"Bob Singh\",\n  \"rank1TechnicalOwnerEmails\": \"bob@example.com\",\n  \"labels\": {\n    \"Business Function\": \"HR\",\n    \"compliance_scope\": \"SOX\"\n  }\n}"},"url":"{{url}}/api/v2/agents"},"status":"Created","code":201,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n  \"agent_id\": \"agent-abc123\",\r\n  \"status\": \"pending\",\r\n  \"created_at\": \"2024-01-01T12:00:00Z\"\r\n}"}],"_postman_id":"4cb9067c-654b-462c-ae83-a0aa0b0ea91c"},{"name":"Update Agent Fields","id":"a5e22764-8e16-4450-bded-6b9c84faacf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"displayName\": \"Updated Agent Name\",\n  \"description\": \"Updated description\",\n  \"criticality\": \"critical\",\n  \"criticalityOverride\": true\n}"},"url":"{{url}}/api/v2/agents/<agentId>","description":"<p>Use this API to partially update the provided fields. Owners and labels have dedicated endpoints.</p>\n<p><strong>Mandatory URL Parameter</strong></p>\n<p><strong>agentId</strong>: Specify the Agent UUID. For example: <code>agent-c8f5d4ce-0235-4009-ac1e-8f2f8df8ec62</code></p>\n<p><strong>Note</strong>: To manually pin criticality, set <code>criticalityOverride</code>to <code>true</code>; set it to <code>false</code> to restore auto-calculation.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a5e22764-8e16-4450-bded-6b9c84faacf0"}],"id":"3aff35da-e635-4746-a981-540d9e82b784","_postman_id":"3aff35da-e635-4746-a981-540d9e82b784","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}}},{"name":"3.0 Lifecycle Transitions","item":[{"name":"Submit for Review","id":"f6cdc872-0055-4491-badc-dd6a52dac873","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{url}}/api/v2/agents/<agentId>/review","description":"<p>Use this API to move the agent from the pending state to governance review.</p>\n<p><strong>Mandatory URL Parameter</strong></p>\n<p><strong>agentId</strong>: Specify the Agent UUID.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>","review"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f6cdc872-0055-4491-badc-dd6a52dac873"},{"name":"Approve Agent","id":"8df018aa-f4b7-4d90-b49d-dfe0f9e4094a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{url}}/api/v2/agents/<agentId>/approve","description":"<p>Use this API to transition the agent to the approved state.</p>\n<p><strong>Mandatory URL Parameter</strong></p>\n<p><strong>agentId</strong>: Specify the Agent UUID.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>","approve"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"8df018aa-f4b7-4d90-b49d-dfe0f9e4094a"},{"name":"Activate Agent","id":"667bd8b5-a5e2-4368-af54-ef99daf65d74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{url}}/api/v2/agents/<agentId>/activate","description":"<p>Use this API to make the agent active for operational use.</p>\n<p><strong>Mandatory URL Parameter</strong></p>\n<p><strong>agentId</strong>: Specify the Agent UUID.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>","activate"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"667bd8b5-a5e2-4368-af54-ef99daf65d74"},{"name":"Suspend Agent","id":"f95c7fd4-64be-4e8d-9194-67d85156225b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{url}}/api/v2/agents/<agentId>/suspend","description":"<p>Use this API to temporarily disable an active agent.</p>\n<p><strong>Note</strong>: The disabled agent can be reactivated.</p>\n<p><strong>Mandatory URL Parameter</strong></p>\n<p><strong>agentId</strong>: Specify the Agent UUID.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>","suspend"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"f95c7fd4-64be-4e8d-9194-67d85156225b"},{"name":"Retire Agent","id":"5ccbf034-a59f-4ecb-a9c8-1dba20468b71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"url":"{{url}}/api/v2/agents/<agentId>/retire","description":"<p>Use this API to permanently decommission an agent.</p>\n<p><strong>Note</strong>: This action cannot be undone.</p>\n<p><strong>Mandatory URL Parameter</strong></p>\n<p><strong>agentId</strong>: Specify the Agent UUID.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>","retire"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5ccbf034-a59f-4ecb-a9c8-1dba20468b71"}],"id":"3fd65e68-129a-4521-972a-7e8792875858","description":"<p>State machine transitions. Valid flow: pending → review → approved → active ⇄ suspended → retired. All return 204 No Content.</p>\n","_postman_id":"3fd65e68-129a-4521-972a-7e8792875858","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}}},{"name":"4.0 Owners & Labels","item":[{"name":"Replace Owner List","id":"4df26625-3758-4604-8884-65a0b052fa9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"rank1BusinessOwnerUserNames\": \"John Doe\",\n  \"rank1BusinessOwnerEmails\": \"john@example.com\",\n  \"rank1TechnicalOwnerUserNames\": \"Jane Smith\",\n  \"rank1TechnicalOwnerEmails\": \"jane@example.com\",\n  \"rank2BusinessOwnerUserNames\": \"Alice Brown\",\n  \"rank2BusinessOwnerEmails\": \"alice@example.com\"\n}"},"url":"{{url}}/api/v2/agents/<agentId>/owners","description":"<p>Use this API to replace the complete owner list. Criticality is recalculated from the new owner counts unless criticalityOverride = true. Supports rank1-3 for both Business and Technical owners.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>","owners"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"9aa33313-cfbd-4ae5-8b88-f35447f78ab3","name":"Replace Owner List","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"rank1BusinessOwnerUserNames\": \"John Doe\",\n  \"rank1BusinessOwnerEmails\": \"john@example.com\",\n  \"rank1TechnicalOwnerUserNames\": \"Jane Smith\",\n  \"rank1TechnicalOwnerEmails\": \"jane@example.com\",\n  \"rank2BusinessOwnerUserNames\": \"Alice Brown\",\n  \"rank2BusinessOwnerEmails\": \"alice@example.com\"\n}"},"url":"https://your-instance.example.com/api/v2/agents/agent-c8f5d4ce-0235-4569-ac1e-8f2f8df8ec62/owners"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n  \"owners\": [\r\n    {\r\n      \"ownerId\": 21,\r\n      \"ownerName\": \"John Doe\",\r\n      \"ownerRole\": \"Business Owner\",\r\n      \"ownerType\": \"User\",\r\n      \"source\": \"Manual\",\r\n      \"rank\": 1,\r\n      \"terminated\": false\r\n    }\r\n  ],\r\n  \"criticality\": \"medium\",\r\n  \"criticalityOverride\": false\r\n}"}],"_postman_id":"4df26625-3758-4604-8884-65a0b052fa9f"},{"name":"Replace Label Map","id":"179eea0c-0b8a-4d79-b40d-a8c5d8d58eeb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"labels\": {\n    \"Risk Level\": \"High\",\n    \"data_sensitivity\": \"PII\",\n    \"compliance_scope\": \"SOX\",\n    \"Lifecycle Stage\": \"Development\"\n  }\n}"},"url":"{{url}}/api/v2/agents/<agentId>/labels","description":"<p>Use this API to replace the complete label set. Send {} to clear all labels. Keys are normalised: lowercase, spaces→underscores. Values must match ^[a-zA-Z0-9_-]+$. Duplicate normalised keys return 400.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","<agentId>","labels"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"4c1b514c-3922-41f2-9dbd-d6954776eaf5","name":"Replace Label Map","originalRequest":{"method":"PATCH","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n  \"labels\": {\n    \"Risk Level\": \"High\",\n    \"data_sensitivity\": \"PII\",\n    \"compliance_scope\": \"SOX\",\n    \"Lifecycle Stage\": \"Development\"\n  }\n}"},"url":"{{url}}/api/v2/agents/<agentId>/labels"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n  \"labels\": {\r\n    \"risk_level\": \"High\",\r\n    \"data_sensitivity\": \"PII\",\r\n    \"compliance_scope\": \"SOX\",\r\n    \"lifecycle_stage\": \"Development\"\r\n  }\r\n}"}],"_postman_id":"179eea0c-0b8a-4d79-b40d-a8c5d8d58eeb"},{"name":"Get Distinct Label Keys","id":"d23342c4-76a2-486e-b62e-466b0ec50c42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/v2/agents/labels?filter=risk&limit=20&offset=0","description":"<p>Returns all distinct normalised label keys across all agents in the tenant, ordered lexicographically ascending.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","labels"],"host":["{{url}}"],"query":[{"description":{"content":"<p>Substring match on key name (optional)</p>\n","type":"text/plain"},"key":"filter","value":"risk"},{"description":{"content":"<p>Max results, max 200 (default 50)</p>\n","type":"text/plain"},"key":"limit","value":"20"},{"description":{"content":"<p>Pagination offset (default 0)</p>\n","type":"text/plain"},"key":"offset","value":"0"}],"variable":[]}},"response":[],"_postman_id":"d23342c4-76a2-486e-b62e-466b0ec50c42"},{"name":"Get Label Taxonomy","id":"f85c2d69-ed93-437a-8a9b-dde028b924bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{url}}/api/v2/agents/labels/categories","description":"<p>Use this API to return the static well-known label taxonomy. Values are suggestions; the API accepts any value matching ^[a-zA-Z0-9_-]+$. Categories: risk_level, data_sensitivity, compliance_scope, lifecycle_stage, agent_autonomy, blueprint_class.</p>\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","agents","labels","categories"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[{"id":"2f733a6d-bd11-4745-9646-60faf0497d61","name":"Get Label Taxonomy","originalRequest":{"method":"GET","header":[],"url":"{{url}}/api/v2/agents/labels/categories"},"status":"OK","code":200,"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n  \"categories\": [\r\n    { \"key\": \"risk_level\", \"displayName\": \"Risk Level\",\r\n      \"values\": [\"Critical\", \"High\", \"Medium\", \"Low\"],\r\n      \"purpose\": \"Drive approval depth and certification frequency.\",\r\n      \"enforcement\": \"Auto-calculated or manual override\" },\r\n    { \"key\": \"data_sensitivity\", \"displayName\": \"Data Sensitivity\",\r\n      \"values\": [\"PII\", \"PHI\", \"Financial\", \"Public\"], ... },\r\n    { \"key\": \"compliance_scope\", \"displayName\": \"Compliance Scope\",\r\n      \"values\": [\"SOX\", \"HIPAA\", \"GDPR\", \"DORA\", \"PCI-DSS\"], ... },\r\n    { \"key\": \"lifecycle_stage\", \"displayName\": \"Lifecycle Stage\",\r\n      \"values\": [\"Development\", \"Testing\", \"Production\", \"Deprecated\"], ... },\r\n    { \"key\": \"agent_autonomy\", \"displayName\": \"Agent Autonomy\",\r\n      \"values\": [\"Assistive\", \"Semi-autonomous\", \"Fully-autonomous\"], ... },\r\n    { \"key\": \"blueprint_class\", \"displayName\": \"Blueprint / Class\",\r\n      \"values\": [\"Automation-Agent\", \"Workflow-Agent\", \"HR-Agent\", ...], ... }\r\n  ]\r\n}"}],"_postman_id":"f85c2d69-ed93-437a-8a9b-dde028b924bf"}],"id":"86b21db8-ace3-454a-8c2e-ea3a240ef942","_postman_id":"86b21db8-ace3-454a-8c2e-ea3a240ef942","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}}},{"name":"5.0 Identity Events","item":[{"name":"Record IGA Lifecycle Event","id":"5381ff48-e068-413e-a2b2-71e21717af23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"X-Correlation-ID","value":"6f563d2c-5f19-4df2-91c2-792a2dbcbc05","description":"<p>UUID for cross-system tracing (required)</p>\n"},{"key":"X-API-Key","value":"","description":"<p>Service-to-service API key (required)</p>\n"}],"body":{"mode":"raw","raw":"{\n  \"userId\": \"sgreene@example.com\",\n  \"eventType\": \"TERMINATE\",\n  \"effectiveDate\": \"2026-02-26T14:30:00Z\",\n  \"initiatedBy\": \"USER_IMPORT\",\n  \"metadata\": {\n    \"reason\": \"Voluntary resignation\",\n    \"ticketId\": \"HR-4821\"\n  }\n}"},"url":"{{url}}/api/v2/identity-events","description":"<p>Use this API to receive IGA lifecycle notifications.</p>\n<p><strong>Note</strong>: Sending the same event twice returns 200 (already exists) instead of 201. The userId is matched against registry_owners.contact to find affected agents. Triggers async criticality recalculation.</p>\n<div class=\"click-to-expand-wrapper is-table-wrapper\"><table>\n<thead>\n<tr>\n<th><strong>Parameter</strong></th>\n<th><strong>Description</strong></th>\n<th><strong>Required</strong></th>\n</tr>\n</thead>\n<tbody>\n<tr>\n<td>userId</td>\n<td>Saviynt Identity Cloud user identifier — matched against owner contact emails</td>\n<td>required</td>\n</tr>\n<tr>\n<td>eventType</td>\n<td>Currently only <code>TERMINATE</code></td>\n<td>required</td>\n</tr>\n<tr>\n<td>effectiveDate</td>\n<td>When the event occurred in IGA (ISO8601)</td>\n<td>required</td>\n</tr>\n<tr>\n<td>initiatedBy</td>\n<td>USER_IMPORT, USER_TRIGGERED, and so on.</td>\n<td>optional</td>\n</tr>\n<tr>\n<td>metadata</td>\n<td>Extensible key-value audit data (reason, ticketId, etc.)</td>\n<td>optional</td>\n</tr>\n</tbody>\n</table>\n</div>","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}},"urlObject":{"path":["api","v2","identity-events"],"host":["{{url}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5381ff48-e068-413e-a2b2-71e21717af23"}],"id":"becba744-405a-4d37-9cbc-fbd23e6803f3","_postman_id":"becba744-405a-4d37-9cbc-fbd23e6803f3","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]},"isInherited":true,"source":{"_postman_id":"ff735f62-0277-4396-9735-6a314066188a","id":"ff735f62-0277-4396-9735-6a314066188a","name":"Identity Security for AI — API Reference","type":"collection"}}}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":""}]}},"variable":[{"key":"baseUrl","value":"https://your-instance.example.com"},{"key":"jwt_token","value":""},{"key":"api_key","value":""},{"key":"agentId","value":"agent-c8f5d4ce-0235-4569-ac1e-8f2f8df8ec62"}]}