{"items":[{"type":"link","label":"Okta for AI Agents","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals","content":{"contentType":"overview","meta":{"name":"Okta for AI Agents"},"children":[{"nodeType":"container","panels":[{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"java","title":"Java","lang":"Java"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"go","title":"Go","lang":"Go"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com","description":"The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains."}}}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Okta for AI Agents","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"APIs for registering, managing, and securing AI agents and their connections to resources in your Okta org."}],"sectionId":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals"},{"nodeType":"external-docs","url":"https://developer.okta.com/","description":"Okta developer documentation and API reference"}],"sectionId":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals"}]}]}},{"type":"separator","label":"Workload Principals","content":null},{"type":"group","label":"Potential Connections","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpotentialconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpotentialconnections","items":[{"label":"List all potential connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpotentialconnections/listpotentialconnectionsbytype","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpotentialconnections/listpotentialconnectionsbytype","metadata":{"seo":{"title":"List all potential connections","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listPotentialConnectionsByType","name":"List all potential connections","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1potential-connections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all potential connections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all global resource connections of a specific connection type that an AI agent can potentially connect to"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only resource connections returned from this request are valid for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentconnections/other/createresourceconnection"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"creating a connection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a matching connection-type protocol."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the required "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections/other/listpotentialconnectionsbytype#other/listpotentialconnectionsbytype/t=request&in=query&path=filter"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to return potential connections with a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connectionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/tags/agentpotentialconnections/other/listpotentialconnectionsbytype#other/listpotentialconnectionsbytype/t=request&in=query&path=match"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"match"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to apply fuzzy-matching on the returned list of potential connections."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_2009","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A required "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression to return a specific type of potential connections."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expression supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the following "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connectionType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_CUSTOM_AS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_VAULT_SECRET"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_SERVICE_ACCOUNT"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can combine multiple expressions using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator to narrow results. For example, filter by connection type and app instance ORN for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connections."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation requires "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#special-characters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"required":true,"examples":{"FilterByCustomASConnectionType":{"summary":"Filter by IDENTITY_ASSERTION_CUSTOM_AS connection type","value":"connectionType eq \"IDENTITY_ASSERTION_CUSTOM_AS\""},"FilterByVaultSecretConnectionType":{"summary":"Filter by STS_VAULT_SECRET connection type","value":"connectionType eq \"STS_VAULT_SECRET\""},"FilterByServiceAccountConnectionType":{"summary":"Filter by STS_SERVICE_ACCOUNT connection type","value":"connectionType eq \"STS_SERVICE_ACCOUNT\""},"FilterByServiceAccountAndAppInstance":{"summary":"Filter by STS_SERVICE_ACCOUNT and specific app instance","value":"connectionType eq \"STS_SERVICE_ACCOUNT\" and appInstanceOrn eq \"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4\""},"FilterBySTSAccessTokenConnectionType":{"summary":"Filter by STS_ACCESS_TOKEN connection type (all resource types)","value":"connectionType eq \"STS_ACCESS_TOKEN\""},"FilterBySTSAccessTokenAppInstance":{"summary":"Filter by STS_ACCESS_TOKEN connection type (APP_INSTANCE only)","value":"connectionType eq \"STS_ACCESS_TOKEN\" and resourceType eq \"APP_INSTANCE\""},"FilterBySTSAccessTokenMcpServer":{"summary":"Filter by STS_ACCESS_TOKEN connection type (MCP_SERVER only)","value":"connectionType eq \"STS_ACCESS_TOKEN\" and resourceType eq \"MCP_SERVER\""},"FilterByA2AServerConnectionType":{"summary":"Filter by IDENTITY_ASSERTION_A2A_SERVER connection type","value":"connectionType eq \"IDENTITY_ASSERTION_A2A_SERVER\""},"FilterByAppInstanceConnectionType":{"summary":"Filter by IDENTITY_ASSERTION_APP_INSTANCE connection type","value":"connectionType eq \"IDENTITY_ASSERTION_APP_INSTANCE\""},"FilterByVirtualMcpServerConnectionType":{"summary":"Filter by IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER connection type","value":"connectionType eq \"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER\""}}},{"name":"match","in":"query","schemaId":"schema_2010","description":"A case-insensitive substring for fuzzy-match that's prefix-friendly"},{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"}],"pointer":"/paths/~1workload-principals~1api~1v1~1potential-connections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/potential-connections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"connectionType eq \"IDENTITY_ASSERTION_CUSTOM_AS\"","schemaId":"schema_2009"},{"name":"match","in":"query","required":false,"example":"agent","schemaId":"schema_2010"},{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403"],"pointer":"/workload-principals/api/v1/potential-connections","href":"agentpotentialconnections/listpotentialconnectionsbytype","openApiOperationId":"listPotentialConnectionsByType","summary":"List all potential connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PotentialConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_CUSTOM_AS potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_VAULT_SECRET potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_SERVICE_ACCOUNT potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_ACCESS_TOKEN potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS_ACCESS_TOKEN potential connections for MCP servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS access token potential connections for API Servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_A2A_SERVER potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections"]}},"schemaId":"components/schemas/PotentialConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_CUSTOM_AS potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_VAULT_SECRET potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_SERVICE_ACCOUNT potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_ACCESS_TOKEN potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS_ACCESS_TOKEN potential connections for MCP servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS access token potential connections for API Servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_A2A_SERVER potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}}},"headerSchemaId":"schema_2013"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/400/content/application~1json/examples/Missing Required Parameter"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/400/content/application~1json/examples/Missing Required Parameter"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/403/content/application~1json/examples/Access Denied"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1potential-connections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/PotentialConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_CUSTOM_AS potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_VAULT_SECRET potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_SERVICE_ACCOUNT potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_ACCESS_TOKEN potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS_ACCESS_TOKEN potential connections for MCP servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS access token potential connections for API Servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_A2A_SERVER potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/PotentialConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_CUSTOM_AS potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_VAULT_SECRET potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_SERVICE_ACCOUNT potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_ACCESS_TOKEN potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS_ACCESS_TOKEN potential connections for MCP servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS access token potential connections for API Servers","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_A2A_SERVER potential connections","paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/400/content/application~1json/examples/Missing Required Parameter"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/400/content/application~1json/examples/Missing Required Parameter"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/403/content/application~1json/examples/Access Denied"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/potential-connections"}],"content":{"contentType":"group","meta":{"name":"AgentPotentialConnections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Potential Connections","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Potential Connections API provides operations that allow you to discover resources for AI agent resource connections. Discoverable resources include those already known to Okta, such as custom authorization servers in your org. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ai-agent-secure"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI agent resource connections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/potential-connections","summary":"List all potential connections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentpotentialconnections/listpotentialconnectionsbytype","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Agent Connections","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections","items":[{"label":"List all AI agent connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/listconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/listconnections","metadata":{"seo":{"title":"List all AI agent connections","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listConnections","name":"List all AI agent connections","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all AI agent connections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all connections for the AI agent"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2014","description":"ID of the agent","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"},{"name":"filter","in":"query","schemaId":"schema_2009","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression to narrow resource connections for the AI agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The expression supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" composition"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"with the following attributes:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"connectionType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceIndicator"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"authorizationServer.orn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.orn"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"and"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" composition is supported in this release (no "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"or"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or other operators)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When omitted, all resource connections for the AI agent are returned."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation requires "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#special-characters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"FilterByIdentityAssertionCustomAS":{"summary":"Filter by IDENTITY_ASSERTION_CUSTOM_AS connection type","value":"connectionType eq \"IDENTITY_ASSERTION_CUSTOM_AS\""},"FilterByVaultedSecret":{"summary":"Filter by STS_VAULT_SECRET connection type","value":"connectionType eq \"STS_VAULT_SECRET\""},"FilterByServiceAccount":{"summary":"Filter by STS_SERVICE_ACCOUNT connection type","value":"connectionType eq \"STS_SERVICE_ACCOUNT\""},"FilterByA2AServer":{"summary":"Find a connection to a specific A2A server by resourceIndicator","value":"resourceIndicator eq \"https://a2a.example.com\""},"FilterActiveIdentityAssertionA2A":{"summary":"Narrow to active A2A identity-assertion connections","value":"connectionType eq \"IDENTITY_ASSERTION_A2A_SERVER\" and status eq \"ACTIVE\""},"FilterByAuthorizationServer":{"summary":"Connections protected by a specific authorization server","value":"authorizationServer.orn eq \"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7\""},"FilterBySTSAccessToken":{"summary":"Filter by STS_ACCESS_TOKEN connection type","value":"connectionType eq \"STS_ACCESS_TOKEN\""},"FilterByA2AServerConnectionType":{"summary":"Filter by IDENTITY_ASSERTION_A2A_SERVER connection type","value":"connectionType eq \"IDENTITY_ASSERTION_A2A_SERVER\""},"FilterByA2AServerByOrn":{"summary":"Same lookup by A2A server ORN","value":"resource.orn eq \"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4\""},"FilterByVirtualMcpServerConnectionType":{"summary":"Filter by IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER connection type","value":"connectionType eq \"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER\""},"FilterByVirtualMcpServerByOrn":{"summary":"Same lookup by virtual MCP server ORN","value":"resource.orn eq \"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k\""}}}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agents/{agentId}/connections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpkhjm0jnDp8RrUu0g4","schemaId":"schema_2014"}],"query":[{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"},{"name":"filter","in":"query","required":false,"example":"connectionType eq \"IDENTITY_ASSERTION_CUSTOM_AS\"","schemaId":"schema_2009"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/connections","href":"agentconnections/listconnections","openApiOperationId":"listConnections","summary":"List all AI agent connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of connections for the AI agent","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including A2A server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by A2A server (URL-encoded filter)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including virtual MCP server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by virtual MCP server (URL-encoded filter)"]}},"schemaId":"components/schemas/ResourceConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including A2A server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by A2A server (URL-encoded filter)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including virtual MCP server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by virtual MCP server (URL-encoded filter)"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}}},"headerSchemaId":"schema_2013"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including A2A server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by A2A server (URL-encoded filter)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including virtual MCP server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by virtual MCP server (URL-encoded filter)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including A2A server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by A2A server (URL-encoded filter)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including virtual MCP server connections)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by virtual MCP server (URL-encoded filter)"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections"},{"label":"Create a resource connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/createresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/createresourceconnection","metadata":{"seo":{"title":"Create a resource connection","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createResourceConnection","name":"Create a resource connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a resource connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a resource connection for the AI agent"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you're not subscribed to Okta for AI Agents and use XAA as part of SSO,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a resource connection of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_CUSTOM_AS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is limited to 250 ID-JAG tokens"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"per user, per resource app, per month. For the purposes of this limit, a \"User\" must be a licensed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"User of Single Sign-On in an Active Status,\" and the total number of XAA users can't exceed"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the org's total purchased SSO users. If you require ID-JAG token volumes above the limit, contact"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"your Okta account team to subscribe to Okta for AI Agents for a platform-wide agentic identity"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"security solution."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2014","description":"ID of the agent","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a vaulted secret connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a service account connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a virtual MCP server"]}},"schemaId":"components/schemas/ResourceConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a vaulted secret connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a service account connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a virtual MCP server"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/connections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpkhjm0jnDp8RrUu0g4","schemaId":"schema_2014"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ResourceConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a vaulted secret connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a service account connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a virtual MCP server"]}},"responseCodes":["201","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/connections","href":"agentconnections/createresourceconnection","openApiOperationId":"createResourceConnection","summary":"Create a resource connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/ResourceConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a vaulted secret connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a service account connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a virtual MCP server"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ResourceConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a vaulted secret connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a service account connection","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a virtual MCP server"]}},"examples":[{},{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A successful connection created response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A resource connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for a virtual MCP server"]}},"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A resource connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for a virtual MCP server"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A resource connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for a virtual MCP server"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A resource connection for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for an app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party MCP server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party API server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for a virtual MCP server"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections"},{"label":"Retrieve an AI agent connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/getresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/getresourceconnection","metadata":{"seo":{"title":"Retrieve an AI agent connection","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getResourceConnection","name":"Retrieve an AI agent connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an AI agent connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a connection for the AI agent"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2014","description":"ID of the agent","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"ID of the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpkhjm0jnDp8RrUu0g4","schemaId":"schema_2014"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","href":"agentconnections/getresourceconnection","openApiOperationId":"getResourceConnection","summary":"Retrieve an AI agent connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successful get a connection response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server"]}},"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}"},{"label":"Update a resource connection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/updateresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/updateresourceconnection","metadata":{"seo":{"title":"Update a resource connection","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateResourceConnection","name":"Update a resource connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a resource connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a resource connection for the AI agent"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Field applicability by connection type:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_CUSTOM_AS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_VAULT_SECRET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset to the default value (the resource's ORN)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopeCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_CUSTOM_AS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_A2A_SERVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connections. The server returns a validation error if these fields are sent for STS connection types."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"issuerUrl"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Valid for identity assertion connections. The server returns a validation error if this field is sent for STS connection types."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validation:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopeCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be provided, and vice versa."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_VAULT_SECRET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection types, only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2014","description":"ID of the agent","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"ID of the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/ResourceConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection."]}},"schemaId":"components/schemas/ResourceConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection."],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpkhjm0jnDp8RrUu0g4","schemaId":"schema_2014"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/ResourceConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection."]}},"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","href":"agentconnections/updateresourceconnection","openApiOperationId":"updateResourceConnection","summary":"Update a resource connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/ResourceConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection."],"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/ResourceConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection."]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful connection update response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated resource connection for a custom authorization server"]}},"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated resource connection for a custom authorization server"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated resource connection for a custom authorization server"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated resource connection for a custom authorization server"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}"},{"label":"Delete an AI agent connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/deleteresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/deleteresourceconnection","metadata":{"seo":{"title":"Delete an AI agent connection","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteResourceConnection","name":"Delete an AI agent connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an AI agent connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a resource connection for the AI agent"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2014","description":"ID of the agent","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"ID of the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpkhjm0jnDp8RrUu0g4","schemaId":"schema_2014"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","href":"agentconnections/deleteresourceconnection","openApiOperationId":"deleteResourceConnection","summary":"Delete an AI agent connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Connection deleted"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}"},{"label":"Activate an AI agent resource connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/activateresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/activateresourceconnection","metadata":{"seo":{"title":"Activate an AI agent resource connection","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateResourceConnection","name":"Activate an AI agent resource connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate an AI agent resource connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activates a resource connection for the AI agent"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2014","description":"ID of the agent","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"ID of the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/activate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpkhjm0jnDp8RrUu0g4","schemaId":"schema_2014"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/activate","href":"agentconnections/activateresourceconnection","openApiOperationId":"activateResourceConnection","summary":"Activate an AI agent resource connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful connection activate response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activate a resource connection for a custom authorization server"]}},"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activate a resource connection for a custom authorization server"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activate a resource connection for a custom authorization server"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activate a resource connection for a custom authorization server"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/activate"},{"label":"Deactivate an AI agent resource connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/deactivateresourceconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentconnections/deactivateresourceconnection","metadata":{"seo":{"title":"Deactivate an AI agent resource connection","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateResourceConnection","name":"Deactivate an AI agent resource connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an AI agent resource connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates a resource connection for the AI agent"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2014","description":"ID of the agent","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"ID of the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/deactivate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpkhjm0jnDp8RrUu0g4","schemaId":"schema_2014"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/deactivate","href":"agentconnections/deactivateresourceconnection","openApiOperationId":"deactivateResourceConnection","summary":"Deactivate an AI agent resource connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful resource connection deactivate response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/A deactivated resource connection"]}},"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/A deactivated resource connection"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/A deactivated resource connection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ResourceConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/A deactivated resource connection"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/deactivate"}],"content":{"contentType":"group","meta":{"name":"AgentConnections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Agent Connections","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AI Agent Connections API provides connection management operations between AI agents and resources. After registering an AI agent, you can set up a resource connection to define the resources that your AI agent can access. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ai-agent-secure"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI agent resource connections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/ai-agents/{agentId}/connections","summary":"List all AI agent connections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentconnections/listconnections","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/connections","summary":"Create a resource connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentconnections/createresourceconnection","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","summary":"Retrieve an AI agent connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentconnections/getresourceconnection","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","summary":"Update a resource connection","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agentconnections/updateresourceconnection","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}","summary":"Delete an AI agent connection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agentconnections/deleteresourceconnection","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/activate","summary":"Activate an AI agent resource connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentconnections/activateresourceconnection","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/connections/{connectionId}/lifecycle/deactivate","summary":"Deactivate an AI agent resource connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentconnections/deactivateresourceconnection","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Agent Credentials","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey","items":[{"label":"List all AI agent JSON Web Keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/listagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/listagentjwk","metadata":{"seo":{"title":"List all AI agent JSON Web Keys","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAgentJwk","name":"List all AI agent JSON Web Keys","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all AI agent JSON Web Keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all JSON Web Keys (JWK) for an AI agent"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks","href":"agentpublickey/listagentjwk","openApiOperationId":"listAgentJwk","summary":"List all AI agent JSON Web Keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2017","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/200/content/application~1json/examples/JSON Web Key list response example"]}},"schemaId":"schema_2017","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/200/content/application~1json/examples/JSON Web Key list response example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/401/content/application~1json/examples/Invalid Token Provided"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/401/content/application~1json/examples/Invalid Token Provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2017","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/200/content/application~1json/examples/JSON Web Key list response example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2017","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/200/content/application~1json/examples/JSON Web Key list response example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/401/content/application~1json/examples/Invalid Token Provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/401/content/application~1json/examples/Invalid Token Provided"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks"},{"label":"Add a JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/addagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/addagentjwk","metadata":{"seo":{"title":"Add a JSON Web Key","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addAgentJwk","name":"Add a JSON Web Key","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a JSON Web Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a new JSON Web Key (JWK) to the AI agent's JWK Set (JWKS)"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody/content/application~1json/examples/RSA JSON Web Key request example"]}},"schemaId":"components/schemas/AgentJsonSigningKeyRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody/content/application~1json/examples/RSA JSON Web Key request example"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody/content/application~1json/examples/RSA JSON Web Key request example"]}},"responseCodes":["201","400","401","403","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks","href":"agentpublickey/addagentjwk","openApiOperationId":"addAgentJwk","summary":"Add a JSON Web Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/AgentJsonSigningKeyRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody/content/application~1json/examples/RSA JSON Web Key request example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody/content/application~1json/examples/RSA JSON Web Key request example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/201/content/application~1json/examples/RSA JSON Web Key example"]}},"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/201/content/application~1json/examples/RSA JSON Web Key example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyNonUniqueKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyDuplicateKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyKidLengthTooShort","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyTooManyKids","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorOnlyOneActiveEncryptionKeyAllowed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyNonUniqueKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyDuplicateKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyKidLengthTooShort","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyTooManyKids","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorOnlyOneActiveEncryptionKeyAllowed"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/401/content/application~1json/examples/Invalid Token Provided"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/401/content/application~1json/examples/Invalid Token Provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/201/content/application~1json/examples/RSA JSON Web Key example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/201/content/application~1json/examples/RSA JSON Web Key example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyNonUniqueKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyDuplicateKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyKidLengthTooShort","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyTooManyKids","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorOnlyOneActiveEncryptionKeyAllowed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyNonUniqueKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyDuplicateKid","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyKidLengthTooShort","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyTooManyKids","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorOnlyOneActiveEncryptionKeyAllowed"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/401/content/application~1json/examples/Invalid Token Provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/401/content/application~1json/examples/Invalid Token Provided"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks"},{"label":"Retrieve an AI agent JSON Web Key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/getagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/getagentjwk","metadata":{"seo":{"title":"Retrieve an AI agent JSON Web Key","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAgentJwk","name":"Retrieve an AI agent JSON Web Key","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an AI agent JSON Web Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an AI agent's JSON Web Key by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keyId"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true},{"name":"keyId","in":"path","schemaId":"schema_2011","description":"Unique identifier of the AI agent's JSON Web Key","required":true,"example":"pks2f4zrZbs8nUa7p0g4"}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"},{"name":"keyId","in":"path","required":true,"example":"pks2f4zrZbs8nUa7p0g4","schemaId":"schema_2011"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}","href":"agentpublickey/getagentjwk","openApiOperationId":"getAgentJwk","summary":"Retrieve an AI agent JSON Web Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/200/content/application~1json/examples/RSA JSON Web Key example"]}},"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/200/content/application~1json/examples/RSA JSON Web Key example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/401/content/application~1json/examples/Invalid Token Provided"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/401/content/application~1json/examples/Invalid Token Provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/200/content/application~1json/examples/RSA JSON Web Key example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/200/content/application~1json/examples/RSA JSON Web Key example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/401/content/application~1json/examples/Invalid Token Provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/401/content/application~1json/examples/Invalid Token Provided"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}"},{"label":"Delete an AI agent JSON Web Key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/deleteagentjwk","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/deleteagentjwk","metadata":{"seo":{"title":"Delete an AI agent JSON Web Key","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAgentJwk","name":"Delete an AI agent JSON Web Key","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an AI agent JSON Web Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an AI agent's JSON Web Key by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". You can only delete an inactive key."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true},{"name":"keyId","in":"path","schemaId":"schema_2011","description":"Unique identifier of the AI agent's JSON Web Key","required":true,"example":"pks2f4zrZbs8nUa7p0g4"}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"},{"name":"keyId","in":"path","required":true,"example":"pks2f4zrZbs8nUa7p0g4","schemaId":"schema_2011"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}","href":"agentpublickey/deleteagentjwk","openApiOperationId":"deleteAgentJwk","summary":"Delete an AI agent JSON Web Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/400/content/application~1json/examples/ErrorDeleteActiveJsonWebKey"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/400/content/application~1json/examples/ErrorDeleteActiveJsonWebKey"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/401/content/application~1json/examples/Invalid Token Provided"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/401/content/application~1json/examples/Invalid Token Provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/400/content/application~1json/examples/ErrorDeleteActiveJsonWebKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/400/content/application~1json/examples/ErrorDeleteActiveJsonWebKey"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/401/content/application~1json/examples/Invalid Token Provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/401/content/application~1json/examples/Invalid Token Provided"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}"},{"label":"Activate an AI agent JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/activateagentjsonwebkey","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/activateagentjsonwebkey","metadata":{"seo":{"title":"Activate an AI agent JSON Web Key","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateAgentJsonWebKey","name":"Activate an AI agent JSON Web Key","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate an AI agent JSON Web Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activates an AI agent's JSON Web Key by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can only have one active encryption key at any given time for an AI agent. When you activate an inactive key, the currently active key is automatically deactivated."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true},{"name":"keyId","in":"path","schemaId":"schema_2011","description":"Unique identifier of the AI agent's JSON Web Key","required":true,"example":"pks2f4zrZbs8nUa7p0g4"}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/activate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"},{"name":"keyId","in":"path","required":true,"example":"pks2f4zrZbs8nUa7p0g4","schemaId":"schema_2011"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/activate","href":"agentpublickey/activateagentjsonwebkey","openApiOperationId":"activateAgentJsonWebKey","summary":"Activate an AI agent JSON Web Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/RSA JSON Web Key example"]}},"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/RSA JSON Web Key example"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/401/content/application~1json/examples/Invalid Token Provided"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/401/content/application~1json/examples/Invalid Token Provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/RSA JSON Web Key example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/RSA JSON Web Key example"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/401/content/application~1json/examples/Invalid Token Provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/401/content/application~1json/examples/Invalid Token Provided"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/activate"},{"label":"Deactivate an AI agent JSON Web Key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/deactivateagentjsonwebkey","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentpublickey/deactivateagentjsonwebkey","metadata":{"seo":{"title":"Deactivate an AI agent JSON Web Key","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateAgentJsonWebKey","name":"Deactivate an AI agent JSON Web Key","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an AI agent JSON Web Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates an AI agent's JSON Web Key by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"keyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" You can only deactivate signing keys. You can't deactivate the active encryption key if the client has ID token encryption enabled. However, you can activate another encryption key, which makes the current key inactive."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true},{"name":"keyId","in":"path","schemaId":"schema_2011","description":"Unique identifier of the AI agent's JSON Web Key","required":true,"example":"pks2f4zrZbs8nUa7p0g4"}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/deactivate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"},{"name":"keyId","in":"path","required":true,"example":"pks2f4zrZbs8nUa7p0g4","schemaId":"schema_2011"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/deactivate","href":"agentpublickey/deactivateagentjsonwebkey","openApiOperationId":"deactivateAgentJsonWebKey","summary":"Deactivate an AI agent JSON Web Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivate JSON Signing Key example"]}},"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivate JSON Signing Key example"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateEncryptionKey"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateEncryptionKey"]},{"code":"401","description":"Unauthorized","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/401/content/application~1json/examples/Invalid Token Provided"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/401/content/application~1json/examples/Invalid Token Provided"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivate JSON Signing Key example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AgentJsonSigningKeyResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivate JSON Signing Key example"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateEncryptionKey"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateEncryptionKey"]}}},{"code":"401","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/401/content/application~1json/examples/Invalid Token Provided"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/401/content/application~1json/examples/Invalid Token Provided"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/deactivate"}],"content":{"contentType":"group","meta":{"name":"AgentPublicKey"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Agent Credentials","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AI Agent Public Keys API provides a set of operations to manage public "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/rfc7517"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Web Key"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (JWK) credentials that are used for AI agents. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ai-agent"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage AI agents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JWK is a JSON representation of a cryptographic key. Okta uses signing keys to verify the signature of a JWT when provided for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"private_key_jwt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" client authentication method or for a signed authorize request object. Okta supports both RSA and Elliptic Curve (EC) keys for signing tokens."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks","summary":"List all AI agent JSON Web Keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentpublickey/listagentjwk","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks","summary":"Add a JSON Web Key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentpublickey/addagentjwk","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}","summary":"Retrieve an AI agent JSON Web Key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentpublickey/getagentjwk","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}","summary":"Delete an AI agent JSON Web Key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agentpublickey/deleteagentjwk","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/activate","summary":"Activate an AI agent JSON Web Key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentpublickey/activateagentjsonwebkey","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/credentials/jwks/{keyId}/lifecycle/deactivate","summary":"Deactivate an AI agent JSON Web Key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentpublickey/deactivateagentjsonwebkey","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Agent Registrations","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration","items":[{"label":"List all AI agents","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/listaiagents","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/listaiagents","metadata":{"seo":{"title":"List all AI agents","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAIAgents","name":"List all AI agents","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all AI agents","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all registered AI agents in Okta"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"},{"name":"search","in":"query","schemaId":"schema_2018","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches for AI agents with a filtering expression. This supports the following operators:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signOnProvider.appInstanceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile.platform"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ge"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"le"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastUpdate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deprecated:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is no longer supported as a filter. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delegation Links API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Query parameter percent encoding is required. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#special-characters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"providerId","in":"query","schemaId":"schema_2011","description":"Searches for AI agents where the provider ID matches the specified value"},{"name":"ownerOrn","in":"query","schemaId":"schema_2011","description":"Searches for AI agents where one of the owner ORNs matches the specified value. This supports a single user ORN or group ORN."},{"name":"orderBy","in":"query","schemaId":"schema_2019","description":"Specifies the sort field for the returned list. If not specified, results are sorted by descending creation date."},{"name":"sortOrder","in":"query","schemaId":"schema_2020","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort direction when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set"},"children":[]}]}]}]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agents","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"},{"name":"search","in":"query","example":"profile.name sw \"Demo Agent\" and status eq \"ACTIVE\" and appId eq \"0oa1qmn4LZQQEH0wZ0g4\"","schemaId":"schema_2018"},{"name":"providerId","in":"query","schemaId":"schema_2011"},{"name":"ownerOrn","in":"query","schemaId":"schema_2011"},{"name":"orderBy","in":"query","schemaId":"schema_2019"},{"name":"sortOrder","in":"query","schemaId":"schema_2020"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","429"],"pointer":"/workload-principals/api/v1/ai-agents","href":"agentregistration/listaiagents","openApiOperationId":"listAIAgents","summary":"List all AI agents"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2021","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with sign-on provider state"]}},"schemaId":"schema_2021","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with sign-on provider state"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2021","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with sign-on provider state"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2021","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with sign-on provider state"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents"},{"label":"Register an AI agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/registeraiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/registeraiagent","metadata":{"seo":{"title":"Register an AI agent","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"registerAIAgent","name":"Register an AI agent","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register an AI agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers an AI agent in Okta. After the AI agent is registered, you can associate credentials and owners with the AI agent, and then activate it."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" If you register an AI agent as a CIMD OAuth client, it won't appear in the Admin Console's Credentials tab."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Credentials tab currently lists only agents registered through other methods and doesn't indicate whether an agent uses CIMD."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This doesn't mean that registration failed."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to an existing app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with a CIMD OAuth client"]}},"schemaId":"components/schemas/CreateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to an existing app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with a CIMD OAuth client"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to an existing app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with a CIMD OAuth client"]}},"responseCodes":["202","400","403","429"],"pointer":"/workload-principals/api/v1/ai-agents","href":"agentregistration/registeraiagent","openApiOperationId":"registerAIAgent","summary":"Register an AI agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/CreateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to an existing app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with a CIMD OAuth client"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to an existing app instance","paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with a CIMD OAuth client"]}},"examples":[{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://subdomain.okta.com/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2022"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents"},{"label":"Retrieve an AI agent","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/getaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/getaiagent","metadata":{"seo":{"title":"Retrieve an AI agent","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAIAgent","name":"Retrieve an AI agent","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an AI agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a registered AI agent by its unique identifier"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agents/{agentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}","href":"agentregistration/getaiagent","openApiOperationId":"getAIAgent","summary":"Retrieve an AI agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgent","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with staged status","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with bound sign-on provider","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent registered with a CIMD OAuth client"]}},"schemaId":"components/schemas/AIAgent","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with staged status","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with bound sign-on provider","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent registered with a CIMD OAuth client"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgent","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with staged status","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with bound sign-on provider","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent registered with a CIMD OAuth client"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgent","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent without an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with staged status","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with an A2A server","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with delegation links (appId deprecated)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with bound sign-on provider","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent registered with a CIMD OAuth client"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Replace an AI agent","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/replaceaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/replaceaiagent","metadata":{"seo":{"title":"Replace an AI agent","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceAIAgent","name":"Replace an AI agent","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace an AI agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces a registered AI agent in Okta. Replacing an agent doesn't remove and recreate the AI agent, so the AI agent retains its credentials and owners. Use this request to perform a full update on an AI agent's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties. To perform a partial update, use the PATCH operation instead."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody/content/application~1json/examples/Replaces an ai-agent"]}},"schemaId":"components/schemas/UpdateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody/content/application~1json/examples/Replaces an ai-agent"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workload-principals/api/v1/ai-agents/{agentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody/content/application~1json/examples/Replaces an ai-agent"]}},"responseCodes":["202","400","403","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}","href":"agentregistration/replaceaiagent","openApiOperationId":"replaceAIAgent","summary":"Replace an AI agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/UpdateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody/content/application~1json/examples/Replaces an ai-agent"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody/content/application~1json/examples/Replaces an ai-agent"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://subdomain.okta.com/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2022"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Update an AI agent","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/updateaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/updateaiagent","metadata":{"seo":{"title":"Update an AI agent","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAIAgent","name":"Update an AI agent","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an AI agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an AI agent. Use this request to perform partial updates on an AI agent's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties. Send only the fields to update. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove a value."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/PatchAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId, name, and description","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update name only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Remove appId and description (set to null)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update resourceUrl to associate an A2A server with the agent","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to an existing app instance"]}},"schemaId":"components/schemas/PatchAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId, name, and description","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update name only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Remove appId and description (set to null)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update resourceUrl to associate an A2A server with the agent","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to an existing app instance"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workload-principals/api/v1/ai-agents/{agentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/PatchAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId, name, and description","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update name only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Remove appId and description (set to null)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update resourceUrl to associate an A2A server with the agent","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to an existing app instance"]}},"responseCodes":["202","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}","href":"agentregistration/updateaiagent","openApiOperationId":"updateAIAgent","summary":"Update an AI agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/PatchAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId, name, and description","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update name only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Remove appId and description (set to null)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update resourceUrl to associate an A2A server with the agent","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to an existing app instance"],"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/PatchAIAgentRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId, name, and description","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update name only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId only","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Remove appId and description (set to null)","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update resourceUrl to associate an A2A server with the agent","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to a new OIDC app instance","paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to an existing app instance"]}},"examples":[{},{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://subdomain.okta.com/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2022"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Delete an AI agent","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/deleteaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/deleteaiagent","metadata":{"seo":{"title":"Delete an AI agent","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAIAgent","name":"Delete an AI agent","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an AI agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a registered AI agent from Okta"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/ai-agents/{agentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}","href":"agentregistration/deleteaiagent","openApiOperationId":"deleteAIAgent","summary":"Delete an AI agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://subdomain.okta.com/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2022"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}},"schemaId":"components/schemas/Error"},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error"}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}"},{"label":"Activate an AI agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/activateaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/activateaiagent","metadata":{"seo":{"title":"Activate an AI agent","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateAIAgent","name":"Activate an AI agent","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate an AI agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activates a registered AI agent in Okta. An AI agent must be activated before it can use its associated credentials to access resources."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/activate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/activate","href":"agentregistration/activateaiagent","openApiOperationId":"activateAIAgent","summary":"Activate an AI agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://subdomain.okta.com/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2022"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/activate"},{"label":"Deactivate an AI agent","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/deactivateaiagent","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentregistration/deactivateaiagent","metadata":{"seo":{"title":"Deactivate an AI agent","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateAIAgent","name":"Deactivate an AI agent","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an AI agent","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates a registered AI agent in Okta"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"agentId","in":"path","schemaId":"schema_2016","description":"ID of the AI agent in Okta","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/deactivate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"agentId","in":"path","required":true,"example":"wlpcFogtKCrK9aYq3fgV","schemaId":"schema_2016"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/deactivate","href":"agentregistration/deactivateaiagent","openApiOperationId":"deactivateAIAgent","summary":"Deactivate an AI agent"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://subdomain.okta.com/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2022"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/deactivate"}],"content":{"contentType":"group","meta":{"name":"AgentRegistration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Agent Registrations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AI Agent Registrations API provides registration and lifecycle management operations for AI agents. A single app can have multiple AI agents linked to it. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ai-agent-register"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Register an AI agent"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/ai-agents","summary":"List all AI agents","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentregistration/listaiagents","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents","summary":"Register an AI agent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentregistration/registeraiagent","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}","summary":"Retrieve an AI agent","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentregistration/getaiagent","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}","summary":"Replace an AI agent","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agentregistration/replaceaiagent","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}","summary":"Update an AI agent","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agentregistration/updateaiagent","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}","summary":"Delete an AI agent","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agentregistration/deleteaiagent","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/activate","summary":"Activate an AI agent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentregistration/activateaiagent","deprecated":false},{"title":"/workload-principals/api/v1/ai-agents/{agentId}/lifecycle/deactivate","summary":"Deactivate an AI agent","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentregistration/deactivateaiagent","deprecated":false}]}]}]}]}},{"type":"group","label":"Workload Principal Operations","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/workloadprincipaloperations","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/workloadprincipaloperations","items":[{"label":"List all workload principal operations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/workloadprincipaloperations/listworkloadprincipaloperations","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/workloadprincipaloperations/listworkloadprincipaloperations","metadata":{"seo":{"title":"List all workload principal operations","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listWorkloadPrincipalOperations","name":"List all workload principal operations","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1operations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all workload principal operations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all workload principal operations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Operations are sorted in descending order from most recent to oldest by creation time."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"},{"name":"search","in":"query","schemaId":"schema_2023","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches for workload principal operations with a filtering expression. This supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation requires "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#special-characters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"sourceInstanceName","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches for workload principal operations of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai-agent:Import"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" where the source name of the app instance contains the specified value"},"children":[]}]}]}]},{"name":"orderBy","in":"query","schemaId":"schema_2019","description":"Specifies the sort field for the returned list. If not specified, results are sorted by descending creation date."},{"name":"sortOrder","in":"query","schemaId":"schema_2020","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort direction when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set"},"children":[]}]}]}]}],"pointer":"/paths/~1workload-principals~1api~1v1~1operations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/operations","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"},{"name":"search","in":"query","example":"type eq \"ai-agent:Import\" and status eq \"COMPLETED\"","schemaId":"schema_2023"},{"name":"sourceInstanceName","in":"query","schemaId":"schema_2011"},{"name":"orderBy","in":"query","schemaId":"schema_2019"},{"name":"sortOrder","in":"query","schemaId":"schema_2020"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/operations","href":"workloadprincipaloperations/listworkloadprincipaloperations","openApiOperationId":"listWorkloadPrincipalOperations","summary":"List all workload principal operations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkloadPrincipalOperationListResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/200/content/application~1json/examples/List of workload principal operations"]}},"schemaId":"components/schemas/WorkloadPrincipalOperationListResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/200/content/application~1json/examples/List of workload principal operations"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1operations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkloadPrincipalOperationListResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/200/content/application~1json/examples/List of workload principal operations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkloadPrincipalOperationListResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/200/content/application~1json/examples/List of workload principal operations"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/operations"},{"label":"Retrieve a workload principal operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/workloadprincipaloperations/getworkloadprincipaloperation","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/workloadprincipaloperations/getworkloadprincipaloperation","metadata":{"seo":{"title":"Retrieve a workload principal operation","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getWorkloadPrincipalOperation","name":"Retrieve a workload principal operation","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a workload principal operation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a workload principal operation and its status"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationId","in":"path","schemaId":"schema_2024","description":"ID of the workload principal operation","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/operations/{operationId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"operationId","in":"path","required":true,"example":"op-1a2b3c4d","schemaId":"schema_2024"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/operations/{operationId}","href":"workloadprincipaloperations/getworkloadprincipaloperation","openApiOperationId":"getWorkloadPrincipalOperation","summary":"Retrieve a workload principal operation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkloadPrincipalOperationResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/In-progress AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Failed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent import operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed virtual MCP operation response"]}},"schemaId":"components/schemas/WorkloadPrincipalOperationResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/In-progress AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Failed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent import operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed virtual MCP operation response"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/WorkloadPrincipalOperationResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/In-progress AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Failed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent import operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed virtual MCP operation response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/WorkloadPrincipalOperationResponse","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/In-progress AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Failed AI agent operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent import operation response","paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed virtual MCP operation response"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/operations/{operationId}"}],"content":{"contentType":"group","meta":{"name":"WorkloadPrincipalOperations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Workload Principal Operations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Workload Principal Operations API provides operations management operations for  workload principals, including AI agents. An operation represents an asynchronous task performed by Okta for a workload principal, such as establishing a connection to a resource server. Operations have a status that you can query to check the progress of the task. For the API related to resource server operations, see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-resource-servers/tags/resourceserveroperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource server operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/operations","summary":"List all workload principal operations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workloadprincipaloperations/listworkloadprincipaloperations","deprecated":false},{"title":"/workload-principals/api/v1/operations/{operationId}","summary":"Retrieve a workload principal operation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/workloadprincipaloperations/getworkloadprincipaloperation","deprecated":false}]}]}]}]}},{"type":"group","label":"AI Agent Providers","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders","items":[{"label":"List all AI agent providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/listaiagentproviders","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/listaiagentproviders","metadata":{"seo":{"title":"List all AI agent providers","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAIAgentProviders","name":"List all AI agent providers","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all AI agent providers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all AI agent providers"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"},{"name":"search","in":"query","schemaId":"schema_2025","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Searches for AI agent providers with a filtering expression. This supports the following operators:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"pr"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"not ({propertyName} pr)"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schedule"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation requires "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#special-characters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"name":"sourceInstanceName","in":"query","schemaId":"schema_2011","description":"Searches for AI agent providers where the source name of the app instance contains the specified value"},{"name":"orderBy","in":"query","schemaId":"schema_2026","description":"Specifies the sort field for the returned list. If not specified, results are sorted by descending creation date."},{"name":"sortOrder","in":"query","schemaId":"schema_2020","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the sort direction when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orderBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set"},"children":[]}]}]}]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agent-providers","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"},{"name":"search","in":"query","example":"sourceName eq \"salesforce\" and sourceId eq \"0oa1qmn4LZQQEH0wZ0g4\" and status eq \"ACTIVE\"","schemaId":"schema_2025"},{"name":"sourceInstanceName","in":"query","schemaId":"schema_2011"},{"name":"orderBy","in":"query","schemaId":"schema_2026"},{"name":"sortOrder","in":"query","schemaId":"schema_2020"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers","href":"agentproviders/listaiagentproviders","openApiOperationId":"listAIAgentProviders","summary":"List all AI agent providers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful AI agent providers list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProviders","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/200/content/application~1json/examples/A list of active AI agent providers"]}},"schemaId":"components/schemas/AIAgentProviders","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/200/content/application~1json/examples/A list of active AI agent providers"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only present if there is another page of results."},"children":[]}]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}}},"headerSchemaId":"schema_2027"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentProviders","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/200/content/application~1json/examples/A list of active AI agent providers"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProviders","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/200/content/application~1json/examples/A list of active AI agent providers"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers"},{"label":"Create an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/createaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/createaiagentprovider","metadata":{"seo":{"title":"Create an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createAIAgentProvider","name":"Create an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an AI agent provider"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider with a schedule"]}},"schemaId":"components/schemas/CreateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider with a schedule"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agent-providers","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider with a schedule"]}},"responseCodes":["201","400","403","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers","href":"agentproviders/createaiagentprovider","openApiOperationId":"createAIAgentProvider","summary":"Create an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/CreateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider with a schedule"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider with a schedule"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A successful response for create an AI agent provider","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider with a schedule"]}},"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider with a schedule"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}}},"headerSchemaId":"schema_2013"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider with a schedule"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider with a schedule"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers"},{"label":"Validate an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/validateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/validateaiagentprovider","metadata":{"seo":{"title":"Validate an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"validateAIAgentProvider","name":"Validate an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Validates an AI agent provider"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody/content/application~1json/examples/A request to validate an AI agent provider"]}},"schemaId":"components/schemas/ValidateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody/content/application~1json/examples/A request to validate an AI agent provider"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agent-providers/validate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ValidateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody/content/application~1json/examples/A request to validate an AI agent provider"]}},"responseCodes":["204","400","403","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/validate","href":"agentproviders/validateaiagentprovider","openApiOperationId":"validateAIAgentProvider","summary":"Validate an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/ValidateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody/content/application~1json/examples/A request to validate an AI agent provider"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ValidateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody/content/application~1json/examples/A request to validate an AI agent provider"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AI agent provider is valid"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/validate"},{"label":"Retrieve an AI agent provider","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/getaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/getaiagentprovider","metadata":{"seo":{"title":"Retrieve an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getAIAgentProvider","name":"Retrieve an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an AI agent provider"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_2028","description":"ID of the AI agent provider","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/ai-agent-providers/{providerId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"example":"aip-1a2b3c4d","schemaId":"schema_2028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/{providerId}","href":"agentproviders/getaiagentprovider","openApiOperationId":"getAIAgentProvider","summary":"Retrieve an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful response for getting an AI agent provider","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider with a schedule"]}},"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider with a schedule"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}}},"headerSchemaId":"schema_2013"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider with a schedule"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider with a schedule"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Replace an AI agent provider","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/replaceaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/replaceaiagentprovider","metadata":{"seo":{"title":"Replace an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceAIAgentProvider","name":"Replace an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces an AI agent provider using strict-update semantics."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All configurable properties must be specified when updating an AI agent provider's profile with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method. Any property not specified in the request is deleted."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Don't use a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method for partial updates."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_2028","description":"ID of the AI agent provider","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider with a schedule"]}},"schemaId":"components/schemas/ReplaceAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider with a schedule"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workload-principals/api/v1/ai-agent-providers/{providerId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"example":"aip-1a2b3c4d","schemaId":"schema_2028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ReplaceAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider with a schedule"]}},"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/{providerId}","href":"agentproviders/replaceaiagentprovider","openApiOperationId":"replaceAIAgentProvider","summary":"Replace an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/ReplaceAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider with a schedule"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider with a schedule"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful AI agent provider replace response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"]}},"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}},"Location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for import status if triggered. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2029"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Update an AI agent provider","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/updateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/updateaiagentprovider","metadata":{"seo":{"title":"Update an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateAIAgentProvider","name":"Update an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an AI agent provider with partial update semantics."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Important:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PATCH"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" method for partial updates."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_2028","description":"ID of the AI agent provider","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/UpdateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider with a schedule"]}},"schemaId":"components/schemas/UpdateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider with a schedule"],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workload-principals/api/v1/ai-agent-providers/{providerId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"example":"aip-1a2b3c4d","schemaId":"schema_2028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/UpdateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider with a schedule"]}},"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/{providerId}","href":"agentproviders/updateaiagentprovider","openApiOperationId":"updateAIAgentProvider","summary":"Update an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/UpdateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider with a schedule"],"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/UpdateAIAgentProviderRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider with a schedule"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A successful AI agent provider update response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"]}},"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}},"Location":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for import status if triggered. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2029"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/AIAgentProvider","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider","paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Delete an AI agent provider","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/deleteaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/deleteaiagentprovider","metadata":{"seo":{"title":"Delete an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteAIAgentProvider","name":"Delete an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes an AI agent provider"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_2028","description":"ID of the AI agent provider","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/ai-agent-providers/{providerId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"example":"aip-1a2b3c4d","schemaId":"schema_2028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","403","404","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/{providerId}","href":"agentproviders/deleteaiagentprovider","openApiOperationId":"deleteAIAgentProvider","summary":"Delete an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AI agent provider deleted"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}"},{"label":"Start the import of an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/startaiagentproviderimport","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/startaiagentproviderimport","metadata":{"seo":{"title":"Start the import of an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"startAIAgentProviderImport","name":"Start the import of an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Start the import of an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Starts the import of an AI agent provider"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_2028","description":"ID of the AI agent provider","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agent-providers/{providerId}/import","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"example":"aip-1a2b3c4d","schemaId":"schema_2028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","403","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/{providerId}/import","href":"agentproviders/startaiagentproviderimport","openApiOperationId":"startAIAgentProviderImport","summary":"Start the import of an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for import status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2030"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}/import"},{"label":"Activate an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/activateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/activateaiagentprovider","metadata":{"seo":{"title":"Activate an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateAIAgentProvider","name":"Activate an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activates an AI agent provider"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_2028","description":"ID of the AI agent provider","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/activate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"example":"aip-1a2b3c4d","schemaId":"schema_2028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","403","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/activate","href":"agentproviders/activateaiagentprovider","openApiOperationId":"activateAIAgentProvider","summary":"Activate an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AI agent provider is activated"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/activate"},{"label":"Deactivate an AI agent provider","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/deactivateaiagentprovider","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/agentproviders/deactivateaiagentprovider","metadata":{"seo":{"title":"Deactivate an AI agent provider","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateAIAgentProvider","name":"Deactivate an AI agent provider","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate an AI agent provider","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates an AI agent provider"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"providerId","in":"path","schemaId":"schema_2028","description":"ID of the AI agent provider","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/deactivate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"providerId","in":"path","required":true,"example":"aip-1a2b3c4d","schemaId":"schema_2028"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","403","429"],"pointer":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/deactivate","href":"agentproviders/deactivateaiagentprovider","openApiOperationId":"deactivateAIAgentProvider","summary":"Deactivate an AI agent provider"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"AI agent provider is deactivated"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/deactivate"}],"content":{"contentType":"group","meta":{"name":"AgentProviders"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"AI Agent Providers","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The AI Agent Providers API provides operations to help manage integrations that allow AI agents from external platforms to be imported and registered in Okta's AI Agents registry in Universal Directory. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ai-agent-imports"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI agent imports"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/ai-agent-providers","summary":"List all AI agent providers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentproviders/listaiagentproviders","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers","summary":"Create an AI agent provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentproviders/createaiagentprovider","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/validate","summary":"Validate an AI agent provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentproviders/validateaiagentprovider","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/{providerId}","summary":"Retrieve an AI agent provider","prefix":{"name":"get","color":"get"},"badges":[],"link":"/agentproviders/getaiagentprovider","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/{providerId}","summary":"Replace an AI agent provider","prefix":{"name":"put","color":"put"},"badges":[],"link":"/agentproviders/replaceaiagentprovider","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/{providerId}","summary":"Update an AI agent provider","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/agentproviders/updateaiagentprovider","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/{providerId}","summary":"Delete an AI agent provider","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/agentproviders/deleteaiagentprovider","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/{providerId}/import","summary":"Start the import of an AI agent provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentproviders/startaiagentproviderimport","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/activate","summary":"Activate an AI agent provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentproviders/activateaiagentprovider","deprecated":false},{"title":"/workload-principals/api/v1/ai-agent-providers/{providerId}/lifecycle/deactivate","summary":"Deactivate an AI agent provider","prefix":{"name":"post","color":"post"},"badges":[],"link":"/agentproviders/deactivateaiagentprovider","deprecated":false}]}]}]}]}},{"type":"group","label":"Delegation Links","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks","items":[{"label":"List all delegation links","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/listdelegationlinks","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/listdelegationlinks","metadata":{"seo":{"title":"List all delegation links","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDelegationLinks","name":"List all delegation links","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all delegation links","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all delegation links. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to filter results."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" logical operators are supported for combining expressions. Use parentheses to control precedence when combining "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To filter by multiple source clients, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn eq \"orn:...client1\" OR from.clientOrn eq \"orn:...client2\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To filter by multiple target resources, use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to.resourceOrn eq \"orn:...A\" OR to.resourceOrn eq \"orn:...B\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To narrow target resources by source client, combine with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and parentheses:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"(to.resourceOrn eq \"orn:...A\" OR to.resourceOrn eq \"orn:...B\") AND from.clientOrn eq \"orn:...client1\""},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Results are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to.resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Resources with no matching delegation links have no entry in the response."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_2031","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A required "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression to return delegation links. The expression supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the following properties. At least one of these properties must be present in the filter:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to.resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The ORN of the target resource (supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator to specify multiple values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The ORN of the source client (supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator to specify multiple values."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The type of the source client (supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). The only currently supported value is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", which restricts results to delegation links whose source is an OAuth 2.0 application."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" logical operators are supported for combining expressions. Use parentheses to control precedence when combining "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation requires "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#special-characters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"required":true,"examples":{"FilterByResourceOrn":{"summary":"Filter by a single target resource ORN","value":"to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8\""},"FilterByClientOrn":{"summary":"Filter by a single source client ORN","value":"from.clientOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ\""},"FilterByResourceOrnAndClientOrn":{"summary":"Filter by target resource ORN and source client ORN","value":"to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8\" AND from.clientOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ\""},"FilterByMultipleResourceOrns":{"summary":"Filter by multiple target resource ORNs","value":"to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8\" OR to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8\""},"FilterByMultipleClientOrns":{"summary":"Filter by multiple source client ORNs","value":"from.clientOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ\" OR from.clientOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oagyrDBKXXHFMGUZBTK\""},"FilterByMultipleResourceOrnsAndClientOrn":{"summary":"Filter by multiple target resource ORNs and source client ORN","value":"(to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8\" OR to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8\") AND from.clientOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ\""},"FilterByMultipleClientOrnsAndResourceOrn":{"summary":"Filter by multiple source client ORNs and target resource ORN","value":"(from.clientOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ\" OR from.clientOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oagyrDBKXXHFMGUZBTK\") AND to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8\""},"FilterByClientTypeApps":{"summary":"Filter by source client type to discover all app-from delegation links","value":"from.clientType eq \"apps\""},"FilterByClientTypeAppsAndResourceOrn":{"summary":"Filter by source client type combined with a target resource ORN","value":"from.clientType eq \"apps\" AND to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8\""}}},{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"},{"name":"expand","in":"query","schemaId":"schema_2032","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If specified, additional data is included on each item under an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute. The parameter accepts multiple values; repeat the parameter to request more than one (e.g. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?expand=appMetadata&expand=customAuthorizationServerMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported values:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"appMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Adds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded.appMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with metadata about the OAuth 2.0 client referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references an AI agent."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agentMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Adds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded.agentMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with metadata about the AI agent referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Omitted when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" references an OAuth 2.0 client."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"customAuthorizationServerMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Adds "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded.customAuthorizationServerMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with metadata about the custom authorization server referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to.authorizationServerOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Skipped when the link uses the org authorization server."},"children":[]}]}]}]}],"examples":{"AppMetadata":{"summary":"Expand to include app metadata","value":"[\"appMetadata\"]"},"AgentMetadata":{"summary":"Expand to include AI agent metadata","value":"[\"agentMetadata\"]"},"CustomAuthorizationServerMetadata":{"summary":"Expand to include custom authorization server metadata","value":"[\"customAuthorizationServerMetadata\"]"},"All":{"summary":"Expand to include app, agent, and custom authorization server metadata","value":"[\"appMetadata\",\"agentMetadata\",\"customAuthorizationServerMetadata\"]"}}}],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/delegation-links","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"to.resourceOrn eq \"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8\"","schemaId":"schema_2031"},{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"},{"name":"expand","in":"query","example":["appMetadata"],"schemaId":"schema_2032"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","429"],"pointer":"/workload-principals/api/v1/delegation-links","href":"delegationlinks/listdelegationlinks","openApiOperationId":"listDelegationLinks","summary":"List all delegation links"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of delegation links","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DelegationLinkList","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=agentMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=customAuthorizationServerMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`"]}},"schemaId":"components/schemas/DelegationLinkList","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=agentMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=customAuthorizationServerMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}],"schema":{"type":"string"}},"X-Rate-Limit-Limit":{"required":true,"description":"The rate-limit ceiling for the current request","schema":{"type":"integer","minimum":1,"example":60}},"X-Rate-Limit-Remaining":{"required":true,"description":"The number of requests left for the current rate-limit window","schema":{"type":"integer","minimum":0,"example":60}},"X-Rate-Limit-Reset":{"required":true,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)","schema":{"type":"integer","minimum":0,"example":1609459200}}},"headerSchemaId":"schema_2013"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DelegationLinkList","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=agentMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=customAuthorizationServerMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DelegationLinkList","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=agentMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=customAuthorizationServerMetadata`","paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/delegation-links"},{"label":"Create a delegation link","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/createdelegationlink","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/createdelegationlink","metadata":{"seo":{"title":"Create a delegation link","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createDelegationLink","name":"Create a delegation link","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a delegation link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a delegation link"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelegationLinkCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an ID token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an AI agent to delegate to another AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an app to delegate to a virtual MCP server with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server"]}},"schemaId":"components/schemas/DelegationLinkCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an ID token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an AI agent to delegate to another AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an app to delegate to a virtual MCP server with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server"],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/delegation-links","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/DelegationLinkCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an ID token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an AI agent to delegate to another AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an app to delegate to a virtual MCP server with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server"]}},"responseCodes":["201","400","403","404","429"],"pointer":"/workload-principals/api/v1/delegation-links","href":"delegationlinks/createdelegationlink","openApiOperationId":"createDelegationLink","summary":"Create a delegation link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/DelegationLinkCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an ID token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an AI agent to delegate to another AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an app to delegate to a virtual MCP server with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DelegationLinkCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an ID token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an AI agent to delegate to another AI agent with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an app to delegate to a virtual MCP server with an access token","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field","paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server"]}},"examples":[{},{},{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A successful delegation link created response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/201/content/application~1json/examples/A created delegation link"]}},"schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/201/content/application~1json/examples/A created delegation link"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/201/content/application~1json/examples/A created delegation link"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/201/content/application~1json/examples/A created delegation link"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/delegation-links"},{"label":"Retrieve a delegation link","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/getdelegationlink","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/getdelegationlink","metadata":{"seo":{"title":"Retrieve a delegation link","description":"BetaOAuth 2.0 scope:okta.aiAgents.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getDelegationLink","name":"Retrieve a delegation link","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a delegation link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a delegation link"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"delegationLinkId","in":"path","schemaId":"schema_2033","description":"ID of the delegation link","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/delegation-links/{delegationLinkId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"delegationLinkId","in":"path","required":true,"example":"dlk1a2b3c4d5e6f7g8h9","schemaId":"schema_2033"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/delegation-links/{delegationLinkId}","href":"delegationlinks/getdelegationlink","openApiOperationId":"getDelegationLink","summary":"Retrieve a delegation link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Successfully retrieved the delegation link","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent","paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent"]}},"schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent","paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent","paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/DelegationLinkWithLinks","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent","paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/delegation-links/{delegationLinkId}"},{"label":"Delete a delegation link","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/deletedelegationlink","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/delegationlinks/deletedelegationlink","metadata":{"seo":{"title":"Delete a delegation link","description":"BetaOAuth 2.0 scope:okta.aiAgents.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteDelegationLink","name":"Delete a delegation link","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a delegation link","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"span","attrs":{"className":"lifecycle-badge beta","style":{"cursor":"pointer","background":"rgb(255, 198, 28)","borderRadius":"6px","marginRight":"8px","padding":"3px","fontSize":"16px","verticalAlign":"super","color":"white","fontWeight":"bold","display":"inline-block"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Beta"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.aiAgents.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a delegation link"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"delegationLinkId","in":"path","schemaId":"schema_2033","description":"ID of the delegation link","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/delegation-links/{delegationLinkId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"delegationLinkId","in":"path","required":true,"example":"dlk1a2b3c4d5e6f7g8h9","schemaId":"schema_2033"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","403","404","429"],"pointer":"/workload-principals/api/v1/delegation-links/{delegationLinkId}","href":"delegationlinks/deletedelegationlink","openApiOperationId":"deleteDelegationLink","summary":"Delete a delegation link"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Delegation link deleted"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/delegation-links/{delegationLinkId}"}],"content":{"contentType":"group","meta":{"name":"DelegationLinks"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delegation Links","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Delegation Links API provides operations for managing delegation links. A delegation link is a security control that defines whether delegation from one entity to another is allowed. Each link specifies a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source and a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" target, expressed in terms of the entities that customers manage in Okta. For example, a delegation link can allow a web client to delegate authority to an AI agent, or allow one AI agent to delegate to another."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a Beta release, is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/delegation-links","summary":"List all delegation links","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delegationlinks/listdelegationlinks","deprecated":false},{"title":"/workload-principals/api/v1/delegation-links","summary":"Create a delegation link","prefix":{"name":"post","color":"post"},"badges":[],"link":"/delegationlinks/createdelegationlink","deprecated":false},{"title":"/workload-principals/api/v1/delegation-links/{delegationLinkId}","summary":"Retrieve a delegation link","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delegationlinks/getdelegationlink","deprecated":false},{"title":"/workload-principals/api/v1/delegation-links/{delegationLinkId}","summary":"Delete a delegation link","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/delegationlinks/deletedelegationlink","deprecated":false}]}]}]}]}},{"type":"group","label":"Virtual MCP Connections","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections","items":[{"label":"List all virtual MCP connections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/listvirtualmcpconnections","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/listvirtualmcpconnections","metadata":{"seo":{"title":"List all virtual MCP connections","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVirtualMCPConnections","name":"List all virtual MCP connections","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all virtual MCP connections","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all connections for the virtual MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"}],"query":[{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections","href":"virtualmcpconnections/listvirtualmcpconnections","openApiOperationId":"listVirtualMCPConnections","summary":"List all virtual MCP connections"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A list of connections for the virtual MCP","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/200/content/application~1json/examples/List all virtual MCP connections"]}},"schemaId":"components/schemas/VirtualMCPConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/200/content/application~1json/examples/List all virtual MCP connections"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualMCPConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/200/content/application~1json/examples/List all virtual MCP connections"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPConnectionList","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/200/content/application~1json/examples/List all virtual MCP connections"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections"},{"label":"Create a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/createvirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/createvirtualmcpconnection","metadata":{"seo":{"title":"Create a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVirtualMCPConnection","name":"Create a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a resource connection for the virtual MCP. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connections to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MCP_SERVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources are supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server"]}},"schemaId":"components/schemas/STSAccessTokenConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server"],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server"]}},"responseCodes":["201","400","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections","href":"virtualmcpconnections/createvirtualmcpconnection","openApiOperationId":"createVirtualMCPConnection","summary":"Create a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/STSAccessTokenConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnectionCreatable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A response confirming the successful creation of the connection.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token connection for a third-party MCP server"]}},"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token connection for a third-party MCP server"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token connection for a third-party MCP server"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token connection for a third-party MCP server"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections"},{"label":"Retrieve a virtual MCP connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/getvirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/getvirtualmcpconnection","metadata":{"seo":{"title":"Retrieve a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVirtualMCPConnection","name":"Retrieve a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a connection for the virtual MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","href":"virtualmcpconnections/getvirtualmcpconnection","openApiOperationId":"getVirtualMCPConnection","summary":"Retrieve a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A response confirming the successful retrieval of the connection.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token connection for a third-party MCP server"]}},"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token connection for a third-party MCP server"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token connection for a third-party MCP server"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token connection for a third-party MCP server"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}"},{"label":"Update a virtual MCP connection","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/updatevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/updatevirtualmcpconnection","metadata":{"seo":{"title":"Update a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVirtualMCPConnection","name":"Update a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a resource connection for the virtual MCP. You can update only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceIndicator"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" field."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/VirtualMCPConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default"]}},"schemaId":"components/schemas/VirtualMCPConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default"],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/VirtualMCPConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default"]}},"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","href":"virtualmcpconnections/updatevirtualmcpconnection","openApiOperationId":"updateVirtualMCPConnection","summary":"Update a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/VirtualMCPConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default"],"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/VirtualMCPConnectionPatchable","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A response confirming the successful update of the connection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated virtual MCP connection"]}},"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated virtual MCP connection"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated virtual MCP connection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated virtual MCP connection"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}"},{"label":"Delete a virtual MCP connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/deletevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/deletevirtualmcpconnection","metadata":{"seo":{"title":"Delete a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteVirtualMCPConnection","name":"Delete a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a resource connection for the virtual MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","href":"virtualmcpconnections/deletevirtualmcpconnection","openApiOperationId":"deleteVirtualMCPConnection","summary":"Delete a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Connection deleted"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}"},{"label":"List all capabilities for a virtual MCP connection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/listvirtualmcpconnectioncapabilities","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/listvirtualmcpconnectioncapabilities","metadata":{"seo":{"title":"List all capabilities for a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVirtualMCPConnectionCapabilities","name":"List all capabilities for a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all capabilities for a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the capabilities for a virtual MCP connection."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?expand=inputSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed the capability's input schema inline."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"},{"name":"expand","in":"query","schemaId":"schema_2035","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional expand parameter. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inputSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed the capability's input schema inline using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"},{"name":"expand","in":"query","schemaId":"schema_2035"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","href":"virtualmcpconnections/listvirtualmcpconnectioncapabilities","openApiOperationId":"listVirtualMCPConnectionCapabilities","summary":"List all capabilities for a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2036","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities with inputSchema expanded"]}},"schemaId":"schema_2036","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities with inputSchema expanded"],"headers":{"Link":{"required":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only present if there is another page of results."},"children":[]}]}]}]}],"schema":{"type":"string"}}},"headerSchemaId":"schema_2037"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2036","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities with inputSchema expanded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2036","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities with inputSchema expanded"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities"},{"label":"Add a capability to a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/addvirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/addvirtualmcpconnectioncapability","metadata":{"seo":{"title":"Add a capability to a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addVirtualMCPConnectionCapability","name":"Add a capability to a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a capability to a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a single capability to the virtual MCP connection."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally includes an admin-defined alias that overrides the capability's default name when exposed through the virtual MCP server."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If no alias is provided, it defaults to the capability name as reported by the upstream resource server."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability with an alias","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability without an alias"]}},"schemaId":"components/schemas/AddVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability with an alias","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability without an alias"],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/AddVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability with an alias","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability without an alias"]}},"responseCodes":["201","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","href":"virtualmcpconnections/addvirtualmcpconnectioncapability","openApiOperationId":"addVirtualMCPConnectionCapability","summary":"Add a capability to a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/AddVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability with an alias","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability without an alias"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/AddVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability with an alias","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability without an alias"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Created","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/201/content/application~1json/examples/Specific capability"]}},"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/201/content/application~1json/examples/Specific capability"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/201/content/application~1json/examples/Specific capability"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/201/content/application~1json/examples/Specific capability"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities"},{"label":"Replace all capabilities for a virtual MCP connection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/replacevirtualmcpconnectioncapabilities","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/replacevirtualmcpconnectioncapabilities","metadata":{"seo":{"title":"Replace all capabilities for a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceVirtualMCPConnectionCapabilities","name":"Replace all capabilities for a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace all capabilities for a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the entire set of capabilities for the virtual MCP connection."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Any capabilities not included in the request body are removed. Capabilities included in the request are added or updated."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Rejects with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error if any alias conflicts exist within the provided list."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceVirtualMCPConnectionCapabilitiesRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody/content/application~1json/examples/Replace all capabilities"]}},"schemaId":"components/schemas/ReplaceVirtualMCPConnectionCapabilitiesRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody/content/application~1json/examples/Replace all capabilities"],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/ReplaceVirtualMCPConnectionCapabilitiesRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody/content/application~1json/examples/Replace all capabilities"]}},"responseCodes":["202","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","href":"virtualmcpconnections/replacevirtualmcpconnectioncapabilities","openApiOperationId":"replaceVirtualMCPConnectionCapabilities","summary":"Replace all capabilities for a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/ReplaceVirtualMCPConnectionCapabilitiesRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody/content/application~1json/examples/Replace all capabilities"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/ReplaceVirtualMCPConnectionCapabilitiesRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody/content/application~1json/examples/Replace all capabilities"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-resource-servers/resourceserveroperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Server Operations API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/resource-servers/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2038"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities"},{"label":"Retrieve a specific capability","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/getvirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/getvirtualmcpconnectioncapability","metadata":{"seo":{"title":"Retrieve a specific capability","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVirtualMCPConnectionCapability","name":"Retrieve a specific capability","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a specific capability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a specific capability by its ID."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?expand=inputSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed the capability's input schema inline."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true},{"name":"capabilityId","in":"path","schemaId":"schema_2039","description":"ID of a specific capability on the virtual MCP server","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"expand","in":"query","schemaId":"schema_2035","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optional expand parameter. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"inputSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to embed the capability's input schema inline using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_embedded"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"},{"name":"capabilityId","in":"path","required":true,"example":"vsc1aB2cD3eF4gH5iJ6k","schemaId":"schema_2039"}],"query":[{"name":"expand","in":"query","schemaId":"schema_2035"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","href":"virtualmcpconnections/getvirtualmcpconnectioncapability","openApiOperationId":"getVirtualMCPConnectionCapability","summary":"Retrieve a specific capability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability with inputSchema expanded"]}},"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability with inputSchema expanded"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability with inputSchema expanded"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability with inputSchema expanded"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}"},{"label":"Update a specific capability","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/updatevirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/updatevirtualmcpconnectioncapability","metadata":{"seo":{"title":"Update a specific capability","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVirtualMCPConnectionCapability","name":"Update a specific capability","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a specific capability","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a specific capability on the virtual MCP connection."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Currently supports updating the alias."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true},{"name":"capabilityId","in":"path","schemaId":"schema_2039","description":"ID of a specific capability on the virtual MCP server","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody/content/application~1json/examples/Update a capability alias"]}},"schemaId":"components/schemas/UpdateVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody/content/application~1json/examples/Update a capability alias"],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"},{"name":"capabilityId","in":"path","required":true,"example":"vsc1aB2cD3eF4gH5iJ6k","schemaId":"schema_2039"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/UpdateVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody/content/application~1json/examples/Update a capability alias"]}},"responseCodes":["200","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","href":"virtualmcpconnections/updatevirtualmcpconnectioncapability","openApiOperationId":"updateVirtualMCPConnectionCapability","summary":"Update a specific capability"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/UpdateVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody/content/application~1json/examples/Update a capability alias"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/UpdateVirtualMCPConnectionCapabilityRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody/content/application~1json/examples/Update a capability alias"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/200/content/application~1json/examples/Specific capability"]}},"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/200/content/application~1json/examples/Specific capability"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/200/content/application~1json/examples/Specific capability"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCPCapability","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/200/content/application~1json/examples/Specific capability"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}"},{"label":"Remove a specific capability from a virtual MCP connection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/removevirtualmcpconnectioncapability","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/removevirtualmcpconnectioncapability","metadata":{"seo":{"title":"Remove a specific capability from a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeVirtualMCPConnectionCapability","name":"Remove a specific capability from a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove a specific capability from a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Removes a specific capability from the virtual MCP connection by its ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true},{"name":"capabilityId","in":"path","schemaId":"schema_2039","description":"ID of a specific capability on the virtual MCP server","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"},{"name":"capabilityId","in":"path","required":true,"example":"vsc1aB2cD3eF4gH5iJ6k","schemaId":"schema_2039"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","href":"virtualmcpconnections/removevirtualmcpconnectioncapability","openApiOperationId":"removeVirtualMCPConnectionCapability","summary":"Remove a specific capability from a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"No Content"},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}"},{"label":"Activate a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/activatevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/activatevirtualmcpconnection","metadata":{"seo":{"title":"Activate a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateVirtualMCPConnection","name":"Activate a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activates a resource connection for the virtual MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/activate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/activate","href":"virtualmcpconnections/activatevirtualmcpconnection","openApiOperationId":"activateVirtualMCPConnection","summary":"Activate a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A response confirming the successful activation of the connection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activated virtual MCP connection"]}},"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activated virtual MCP connection"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activated virtual MCP connection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activated virtual MCP connection"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/activate"},{"label":"Deactivate a virtual MCP connection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/deactivatevirtualmcpconnection","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpconnections/deactivatevirtualmcpconnection","metadata":{"seo":{"title":"Deactivate a virtual MCP connection","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateVirtualMCPConnection","name":"Deactivate a virtual MCP connection","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a virtual MCP connection","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates a resource connection for the virtual MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true},{"name":"connectionId","in":"path","schemaId":"schema_2015","description":"Unique identifier for the connection","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/deactivate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"},{"name":"connectionId","in":"path","required":true,"example":"mcn1a2b3c4d5e6f7g8h9","schemaId":"schema_2015"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/deactivate","href":"virtualmcpconnections/deactivatevirtualmcpconnection","openApiOperationId":"deactivateVirtualMCPConnection","summary":"Deactivate a virtual MCP connection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A response confirming the successful deactivation of the connection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivated virtual MCP connection"]}},"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivated virtual MCP connection"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivated virtual MCP connection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/STSAccessTokenConnection","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivated virtual MCP connection"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/deactivate"}],"content":{"contentType":"group","meta":{"name":"VirtualMCPConnections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual MCP Connections","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Virtual MCP Connections API provides connection management operations between virtual MCP servers and downstream resource servers. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/secures-ai-wlp-virtual-mcp-servers/virtualmcpsettings"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Virtual MCP Settings"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for supported connection types and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/mcp-servers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP Servers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/release-lifecycle#research-release"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Research Release"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections","summary":"List all virtual MCP connections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualmcpconnections/listvirtualmcpconnections","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections","summary":"Create a virtual MCP connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtualmcpconnections/createvirtualmcpconnection","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","summary":"Retrieve a virtual MCP connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualmcpconnections/getvirtualmcpconnection","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","summary":"Update a virtual MCP connection","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/virtualmcpconnections/updatevirtualmcpconnection","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}","summary":"Delete a virtual MCP connection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtualmcpconnections/deletevirtualmcpconnection","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","summary":"List all capabilities for a virtual MCP connection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualmcpconnections/listvirtualmcpconnectioncapabilities","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","summary":"Add a capability to a virtual MCP connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtualmcpconnections/addvirtualmcpconnectioncapability","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities","summary":"Replace all capabilities for a virtual MCP connection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/virtualmcpconnections/replacevirtualmcpconnectioncapabilities","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","summary":"Retrieve a specific capability","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualmcpconnections/getvirtualmcpconnectioncapability","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","summary":"Update a specific capability","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/virtualmcpconnections/updatevirtualmcpconnectioncapability","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/capabilities/{capabilityId}","summary":"Remove a specific capability from a virtual MCP connection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtualmcpconnections/removevirtualmcpconnectioncapability","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/activate","summary":"Activate a virtual MCP connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtualmcpconnections/activatevirtualmcpconnection","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/connections/{connectionId}/lifecycle/deactivate","summary":"Deactivate a virtual MCP connection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtualmcpconnections/deactivatevirtualmcpconnection","deprecated":false}]}]}]}]}},{"type":"group","label":"Virtual MCP Server Registrations","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration","items":[{"label":"List all virtual MCPs","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/listvirtualmcps","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/listvirtualmcps","metadata":{"seo":{"title":"List all virtual MCPs","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listVirtualMCPs","name":"List all virtual MCPs","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all virtual MCPs","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all virtual MCPs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_2011","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#link-header"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link header"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_2012","description":"A limit on the number of objects to return"},{"name":"filter","in":"query","schemaId":"schema_2040","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filters virtual MCPs with a filtering expression. This supports the following operators:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile.displayName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This operation requires "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#special-characters"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Special characters"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/virtual-mcp-servers","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"after","in":"query","schemaId":"schema_2011"},{"name":"limit","in":"query","schemaId":"schema_2012"},{"name":"filter","in":"query","example":"profile.displayName sw \"Production\" and status eq \"ACTIVE\"","schemaId":"schema_2040"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers","href":"virtualmcpregistration/listvirtualmcps","openApiOperationId":"listVirtualMCPs","summary":"List all virtual MCPs"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2041","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/200/content/application~1json/examples/List of virtual MCPs"]}},"schemaId":"schema_2041","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/200/content/application~1json/examples/List of virtual MCPs"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_2041","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/200/content/application~1json/examples/List of virtual MCPs"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2041","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/200/content/application~1json/examples/List of virtual MCPs"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers"},{"label":"Create a virtual MCP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/createvirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/createvirtualmcp","metadata":{"seo":{"title":"Create a virtual MCP","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createVirtualMCP","name":"Create a virtual MCP","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a virtual MCP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a virtual MCP"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody/content/application~1json/examples/Create a virtual MCP"]}},"schemaId":"components/schemas/CreateVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody/content/application~1json/examples/Create a virtual MCP"],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/virtual-mcp-servers","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/CreateVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody/content/application~1json/examples/Create a virtual MCP"]}},"responseCodes":["202","400","403","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers","href":"virtualmcpregistration/createvirtualmcp","openApiOperationId":"createVirtualMCP","summary":"Create a virtual MCP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/CreateVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody/content/application~1json/examples/Create a virtual MCP"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/CreateVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody/content/application~1json/examples/Create a virtual MCP"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2042"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers"},{"label":"Retrieve a virtual MCP","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/getvirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/getvirtualmcp","metadata":{"seo":{"title":"Retrieve a virtual MCP","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVirtualMCP","name":"Retrieve a virtual MCP","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a virtual MCP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a virtual MCP by ID"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","href":"virtualmcpregistration/getvirtualmcp","openApiOperationId":"getVirtualMCP","summary":"Retrieve a virtual MCP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Active virtual MCP","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Inactive virtual MCP"]}},"schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Active virtual MCP","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Inactive virtual MCP"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Active virtual MCP","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Inactive virtual MCP"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Active virtual MCP","paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Inactive virtual MCP"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}"},{"label":"Update a virtual MCP","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/updatevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/updatevirtualmcp","metadata":{"seo":{"title":"Update a virtual MCP","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateVirtualMCP","name":"Update a virtual MCP","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a virtual MCP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a virtual MCP. Use this request to perform partial updates on virtual MCP properties. Send only the fields to update. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to remove a value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/PatchVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody/content/application~1merge-patch+json/examples/Update display name and description"]}},"schemaId":"components/schemas/PatchVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody/content/application~1merge-patch+json/examples/Update display name and description"],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/merge-patch+json":{"schemaId":"components/schemas/PatchVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody/content/application~1merge-patch+json/examples/Update display name and description"]}},"responseCodes":["200","400","403","404","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","href":"virtualmcpregistration/updatevirtualmcp","openApiOperationId":"updateVirtualMCP","summary":"Update a virtual MCP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/PatchVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody/content/application~1merge-patch+json/examples/Update display name and description"],"mediaTypes":["application/merge-patch+json"],"mediaTypeSchemas":{"application/merge-patch+json":{"schemaId":"components/schemas/PatchVirtualMCPRequest","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody/content/application~1merge-patch+json/examples/Update display name and description"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/200/content/application~1json/examples/Active virtual MCP"]}},"schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/200/content/application~1json/examples/Active virtual MCP"]},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/200/content/application~1json/examples/Active virtual MCP"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMCP","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/200/content/application~1json/examples/Active virtual MCP"]}}},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}"},{"label":"Delete a virtual MCP","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/deletevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/deletevirtualmcp","metadata":{"seo":{"title":"Delete a virtual MCP","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteVirtualMCP","name":"Delete a virtual MCP","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a virtual MCP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a virtual MCP. You can't delete a virtual MCP that has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","href":"virtualmcpregistration/deletevirtualmcp","openApiOperationId":"deleteVirtualMCP","summary":"Delete a virtual MCP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2042"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}"},{"label":"Activate a virtual MCP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/activatevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/activatevirtualmcp","metadata":{"seo":{"title":"Activate a virtual MCP","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"activateVirtualMCP","name":"Activate a virtual MCP","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Activate a virtual MCP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Activates a virtual MCP, transitioning it from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The virtual MCP must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to be activated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/activate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/activate","href":"virtualmcpregistration/activatevirtualmcp","openApiOperationId":"activateVirtualMCP","summary":"Activate a virtual MCP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2042"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/activate"},{"label":"Deactivate a virtual MCP","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/deactivatevirtualmcp","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpregistration/deactivatevirtualmcp","metadata":{"seo":{"title":"Deactivate a virtual MCP","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deactivateVirtualMCP","name":"Deactivate a virtual MCP","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deactivate a virtual MCP","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.manage"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deactivates a virtual MCP, transitioning it from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The virtual MCP must be in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status to be deactivated."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"virtualMcpServerId","in":"path","schemaId":"schema_2034","description":"ID of a virtual MCP","required":true}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/deactivate","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"virtualMcpServerId","in":"path","required":true,"example":"wlp1aB2cD3eF4gH5iJ6k","schemaId":"schema_2034"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","400","403","404","409","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/deactivate","href":"virtualmcpregistration/deactivatevirtualmcp","openApiOperationId":"deactivateVirtualMCP","summary":"Deactivate a virtual MCP"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Accepted","headers":{"Location":{"required":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"schema":{"type":"string","format":"uri"},"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"headerSchemaId":"schema_2042"},{"code":"400","description":"Bad Request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]},{"code":"404","description":"Not Found","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]},{"code":"409","description":"Conflict","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"400","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"404","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"]}}},{"code":"409","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/deactivate"}],"content":{"contentType":"group","meta":{"name":"VirtualMCPRegistration"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual MCP Server Registrations","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Virtual Model Context Protocol (MCP) Server Registrations API provides registration and lifecycle management operations for virtual MCPs. A virtual MCP serves as a consolidated interface for multiple underlying resource servers as a single, unified MCP to an AI agent. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/mcp-servers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP Servers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/release-lifecycle/#research-release"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Research Release"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/virtual-mcp-servers","summary":"List all virtual MCPs","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualmcpregistration/listvirtualmcps","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers","summary":"Create a virtual MCP","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtualmcpregistration/createvirtualmcp","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","summary":"Retrieve a virtual MCP","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualmcpregistration/getvirtualmcp","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","summary":"Update a virtual MCP","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/virtualmcpregistration/updatevirtualmcp","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}","summary":"Delete a virtual MCP","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/virtualmcpregistration/deletevirtualmcp","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/activate","summary":"Activate a virtual MCP","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtualmcpregistration/activatevirtualmcp","deprecated":false},{"title":"/workload-principals/api/v1/virtual-mcp-servers/{virtualMcpServerId}/lifecycle/deactivate","summary":"Deactivate a virtual MCP","prefix":{"name":"post","color":"post"},"badges":[],"link":"/virtualmcpregistration/deactivatevirtualmcp","deprecated":false}]}]}]}]}},{"type":"group","label":"Virtual MCP Settings","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpsettings","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpsettings","items":[{"label":"Retrieve the Virtual MCP Settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpsettings/getvirtualmcpsettings","routeSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals/virtualmcpsettings/getvirtualmcpsettings","metadata":{"seo":{"title":"Retrieve the Virtual MCP Settings","description":"OAuth 2.0 scope:okta.resourceServers.virtualMcpServers.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getVirtualMcpSettings","name":"Retrieve the Virtual MCP Settings","isWebhook":false,"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the Virtual MCP Settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"marginTop":"16px","marginBottom":"24px","fontFamily":"sans-serif","display":"block","clear":"both"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/oauth2/","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"OAuth 2.0 scope:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"okta.resourceServers.virtualMcpServers.read"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"div","attrs":{"style":{"display":"flex","alignItems":"flex-start","gap":"8px","marginTop":"12px"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"a","attrs":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#iam-access-to-api-resources","style":{"padding":"4px 0px","flex":"0 0 135px","fontSize":"16px","fontWeight":"600","color":"#1d1d21","textDecoration":"none","marginBottom":"8px"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"Admin roles:"},"children":[]}]},{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"ul","attrs":{"style":{"padding":"0","margin":"0","listStyle":"none","display":"flex","flexWrap":"wrap","flex":"1"}}},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","attributes":{"name":"li","attrs":{"style":{"display":"inline-flex","alignItems":"center","backgroundColor":"#ededed","color":"#4b4b4b","padding":"4px 12px","borderRadius":"16px","fontSize":"14px","marginRight":"8px","marginBottom":"8px","lineHeight":"20px","border":"1px solid transparent"}}},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"SUPER_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the org-level settings for virtual MCPs"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"x-lifecycle","attrs":{"className":"research"}},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/workload-principals/api/v1/virtual-mcp-settings","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","403","429"],"pointer":"/workload-principals/api/v1/virtual-mcp-settings","href":"virtualmcpsettings/getvirtualmcpsettings","openApiOperationId":"getVirtualMcpSettings","summary":"Retrieve the Virtual MCP Settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"OK","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMcpSettings","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/200/content/application~1json/examples/Virtual MCP Settings"]}},"schemaId":"components/schemas/VirtualMcpSettings","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/200/content/application~1json/examples/Virtual MCP Settings"]},{"code":"403","description":"Forbidden","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/403/content/application~1json/examples/Access Denied"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/403/content/application~1json/examples/Access Denied"]},{"code":"429","description":"Too Many Requests","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/429/content/application~1json/examples/Too Many Requests"]}},"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/429/content/application~1json/examples/Too Many Requests"]}],"pointer":"/paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/VirtualMcpSettings","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/200/content/application~1json/examples/Virtual MCP Settings"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/VirtualMcpSettings","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/200/content/application~1json/examples/Virtual MCP Settings"]}}},{"code":"403","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/403/content/application~1json/examples/Access Denied"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/403/content/application~1json/examples/Access Denied"]}}},{"code":"429","schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/429/content/application~1json/examples/Too Many Requests"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Error","exampleIds":["paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/429/content/application~1json/examples/Too Many Requests"]}}}],"examples":[]}]}]}]},"httpPath":"/workload-principals/api/v1/virtual-mcp-settings"}],"content":{"contentType":"group","meta":{"name":"VirtualMCPSettings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Virtual MCP Settings","showPageActions":true},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Virtual MCP Settings API provides operations for org-level configuration and limits for virtual MCPs. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/mcp-servers"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"MCP Servers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" This API, which is available as a "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/release-lifecycle#research-release"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Research Release"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", is only available if you're subscribed to Okta for AI Agents. Contact Okta Support for more information."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/workload-principals/api/v1/virtual-mcp-settings","summary":"Retrieve the Virtual MCP Settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/virtualmcpsettings/getvirtualmcpsettings","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/A2AServerHrefObjectResourceServerLink":{"id":"components/schemas/A2AServerHrefObjectResourceServerLink","kind":"json-schema","title":"A2AServerHrefObjectResourceServerLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the associated agent-to-agent (A2A) server resource"}]}},"components/schemas/A2aServerLinks":{"id":"components/schemas/A2aServerLinks","kind":"json-schema","title":"A2aServerLinks","data":{"description":"Specifies link relations available for the agent-to-agent (A2A) server","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the A2A server through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the A2A server in the Admin Console"}},"required":["self"]}},"components/schemas/A2aServerOrn":{"id":"components/schemas/A2aServerOrn","kind":"json-schema","title":"A2aServerOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the A2A server"},"children":[]}]}]}],"type":"string"}},"components/schemas/AIAgent":{"id":"components/schemas/AIAgent","kind":"json-schema","title":"AIAgent","data":{"type":"object","properties":{"appId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the connected app for the AI agent. Deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delegation Links API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"readOnly":false,"deprecated":true},"created":{"type":"string","format":"date-time","description":"Timestamp when the AI agent was created","readOnly":true},"externalId":{"type":"string","description":"Unique external ID for an AI agent","readOnly":true,"deprecated":true},"id":{"type":"string","description":"Unique ID for the AI agent in Okta","readOnly":true},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the AI agent was updated","readOnly":true},"platform":{"type":"string","deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hosting platform of the AI agent. The following are example supported platforms:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"*"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWS_BEDROCK_AGENTS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AWS_BEDROCK_AGENTCORE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SALESFORCE_AGENTFORCE"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GEMINI_ENTERPRISE_AGENT_PLATFORM"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MICROSOFT_COPILOT_STUDIO"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MICROSOFT_FOUNDRY"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SERVICENOW"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DATAROBOT_AGENT_WORKFORCE_PLATFORM"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLAUDE_MANAGED_AGENTS"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WORKDAY_ASOR"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LANGSMITH_AGENTS"},"children":[]}]}]}]}]},"profile":{"$ref":"#/components/schemas/AIAgentProfile"},"status":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When an AI agent is created, it's in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STAGED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status. After credentials and owners are associated with the agent, you can set it to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" status."},"children":[]}]}]}],"enum":["ACTIVE","INACTIVE","STAGED"]},"_links":{"$ref":"#/components/schemas/AIAgentLinks"},"oauthClient":{"$ref":"#/components/schemas/WorkloadPrincipalOAuthClient"},"signOnProvider":{"$ref":"#/components/schemas/WorkloadPrincipalSignOnProvider"}}}},"components/schemas/AIAgentEmbedded":{"id":"components/schemas/AIAgentEmbedded","kind":"json-schema","title":"AIAgentEmbedded","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data embedded on an AI agent through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. Each property is only present when the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value was requested and the underlying data exists for the AI agent."},"children":[]}]}]}],"type":"object","properties":{"sources":{"type":"object","additionalProperties":true}}}},"components/schemas/AIAgentExternalId":{"id":"components/schemas/AIAgentExternalId","kind":"json-schema","title":"AIAgentExternalId","data":{"maxLength":255,"description":"Unique external ID for an AI agent","type":"string"}},"components/schemas/AIAgentLinks":{"id":"components/schemas/AIAgentLinks","kind":"json-schema","title":"AIAgentLinks","data":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksProviders"},{"type":"object","properties":{"resourceServer":{"$ref":"#/components/schemas/A2AServerHrefObjectResourceServerLink"},"delegationLinks":{"$ref":"#/components/schemas/HrefObjectDelegationLinksLink"}}}]}},"components/schemas/AIAgentPlatform":{"id":"components/schemas/AIAgentPlatform","kind":"json-schema","title":"AIAgentPlatform","data":{"minLength":1,"maxLength":100,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The hosting platform of the AI agent. Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is provided. Custom values beyond the listed enum are also accepted."},"children":[]}]}]}],"type":"string","enum":["AWS_BEDROCK_AGENTS","AWS_BEDROCK_AGENTCORE","SALESFORCE_AGENTFORCE","GEMINI_ENTERPRISE_AGENT_PLATFORM","MICROSOFT_COPILOT_STUDIO","MICROSOFT_FOUNDRY","SERVICENOW","DATAROBOT_AGENT_WORKFORCE_PLATFORM","CLAUDE_MANAGED_AGENTS","WORKDAY_ASOR","LANGSMITH_AGENTS"]}},"components/schemas/AIAgentProfile":{"id":"components/schemas/AIAgentProfile","kind":"json-schema","title":"AIAgentProfile","data":{"description":"AI agent profile","type":"object","properties":{"description":{"type":"string","description":"Description of the AI agent","maxLength":1024},"name":{"type":"string","description":"Unique name of the AI agent","minLength":3,"maxLength":100}},"required":["name"]}},"components/schemas/AIAgentProvider":{"id":"components/schemas/AIAgentProvider","kind":"json-schema","title":"AIAgentProvider","data":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the AI agent provider","minLength":1},"integrationDate":{"type":"string","format":"date-time","description":"The date and time when the AI agent provider was integrated"},"lastImportDate":{"type":"string","format":"date-time","description":"The date and time when the last import from the AI agent provider occurred"},"owners":{"$ref":"#/components/schemas/Owners"},"sourceId":{"type":"string","description":"The ID of the source","minLength":20,"maxLength":20},"sourceName":{"type":"string","description":"The name of the source","minLength":1,"maxLength":255},"sourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the source"},"children":[]}]}]}]},"sourceType":{"type":"string","description":"The type of the source","minLength":1,"maxLength":10},"status":{"$ref":"#/components/schemas/AIAgentProviderStatus"},"_links":{"$ref":"#/components/schemas/LinksSelf"},"nextScheduledImportDate":{"type":"string","format":"date-time","description":"The date and time of the next scheduled import from the AI agent provider"},"schedule":{"$ref":"#/components/schemas/Schedule"}},"required":["id","sourceOrn","sourceId","sourceName","sourceType","status","_links"]}},"components/schemas/AIAgentProviderAttributes":{"id":"components/schemas/AIAgentProviderAttributes","kind":"json-schema","title":"AIAgentProviderAttributes","data":{"description":"A list of AI agent attributes defined in the provider","type":"object","properties":{"data":{"type":"array","items":{"type":"string"},"description":"List of AI agent attribute names defined in the provider"},"_links":{"$ref":"#/components/schemas/LinksSelf"}}}},"components/schemas/AIAgentProviderDeDupExpression":{"id":"components/schemas/AIAgentProviderDeDupExpression","kind":"json-schema","title":"AIAgentProviderDeDupExpression","data":{"description":"Expression to uniquely identify imported agents. If not provided, the default behavior is to use the agent's external ID as the unique identifier. Custom values beyond the listed enum are also accepted.","example":"target.profile.externalId eq source.profile.externalId","type":"string","enum":["target.profile.externalId eq source.profile.externalId","target.profile.externalId eq source.profile.externalId and target.profile.platform eq source.profile.platform","target.profile.externalId eq source.profile.externalId and target.profile.name eq source.profile.name","target.profile.externalId eq source.profile.externalId and target.profile.name eq source.profile.name and target.profile.platform eq source.profile.platform"]}},"components/schemas/AIAgentProviderProfileMapping":{"id":"components/schemas/AIAgentProviderProfileMapping","kind":"json-schema","title":"AIAgentProviderProfileMapping","data":{"description":"Defines the attribute mappings from the source app to the AI agent profile","type":"object","properties":{"propertyMappings":{"type":"array","description":"List of attribute mapping rules from the source app to the AI agent profile","items":{"$ref":"#/components/schemas/AIAgentProviderProfileMappingProperty"}}}}},"components/schemas/AIAgentProviderProfileMappingProperty":{"id":"components/schemas/AIAgentProviderProfileMappingProperty","kind":"json-schema","title":"AIAgentProviderProfileMappingProperty","data":{"description":"Defines the mapping rule for a single AI agent profile attribute","type":"object","properties":{"sourceExpression":{"type":"string","description":"OEL expression that maps the source attribute value to the target field","example":"source.agentName"},"targetField":{"type":"string","description":"Target AI agent profile attribute name","example":"agentName"}}}},"components/schemas/AIAgentProviderSourcePriority":{"id":"components/schemas/AIAgentProviderSourcePriority","kind":"json-schema","title":"AIAgentProviderSourcePriority","data":{"description":"The priority entry for a single AI agent provider integration source","type":"object","properties":{"enabledPlatforms":{"type":"array","description":"The AI agent platform identifiers enabled for this integration source","items":{"type":"string"}},"id":{"type":"string","description":"The ID of the app instance that acts as the integration source for this provider","minLength":20,"maxLength":20},"priority":{"type":"integer","description":"The relative priority of this integration source. Lower values indicate higher priority. Values are assigned in multiples of 10 (10, 20, 30, ...) to leave space for future insertions.","minimum":1,"example":10},"providerId":{"type":"string","description":"The ID of the AI agent provider that manages this integration source","example":"aip-1a2b3c4d"}},"required":["id","priority"]}},"components/schemas/AIAgentProviderSourcePriorityItem":{"id":"components/schemas/AIAgentProviderSourcePriorityItem","kind":"json-schema","title":"AIAgentProviderSourcePriorityItem","data":{"description":"An integration source reference used in the priority order","type":"object","properties":{"id":{"type":"string","description":"The ID of the app instance that acts as the integration source for this provider","minLength":20,"maxLength":20}},"required":["id"]}},"components/schemas/AIAgentProviderSourcePriorityList":{"id":"components/schemas/AIAgentProviderSourcePriorityList","kind":"json-schema","title":"AIAgentProviderSourcePriorityList","data":{"description":"An ordered list of AI agent provider integration source priorities, from highest to lowest priority","type":"object","properties":{"data":{"type":"array","description":"A list of integration sources in the current priority order, highest priority first","minItems":0,"items":{"$ref":"#/components/schemas/AIAgentProviderSourcePriority"}},"reconciliationInProgress":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether a priority reconciliation job is currently scheduled or running. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a priority order update may be scheduled or currently updating and the UI should prevent further reordering until the operation completes."},"children":[]}]}]}],"example":true},"_links":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}},"required":["data","_links"]}},"components/schemas/AIAgentProviderStage":{"id":"components/schemas/AIAgentProviderStage","kind":"json-schema","title":"AIAgentProviderStage","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview option to unify identity for imported agents. If not provided, the default behavior is to import agents as AUTO_MERGE."},"children":[]}]}]}],"type":"string","enum":["AUTO_MERGE","DUPLICATE","NEWLY_IMPORTED"]}},"components/schemas/AIAgentProviderStats":{"id":"components/schemas/AIAgentProviderStats","kind":"json-schema","title":"AIAgentProviderStats","data":{"description":"Stats for a single AI agent provider","type":"object","properties":{"agentCount":{"type":"integer","description":"The number of imported AI agents currently associated with this provider","minimum":0},"providerId":{"type":"string","description":"The ID of the AI agent provider","minLength":1}},"required":["providerId","agentCount"]}},"components/schemas/AIAgentProviderStatsList":{"id":"components/schemas/AIAgentProviderStatsList","kind":"json-schema","title":"AIAgentProviderStatsList","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A bulk-lookup response that contains stats for the AI agent providers requested through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Providers requested in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ids"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that don't exist or have no associated agents are omitted from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Callers should treat any missing provider ID as having an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agentCount"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/AIAgentProviderStats"}},"_links":{"$ref":"#/components/schemas/LinksSelf"}},"required":["data","_links"]}},"components/schemas/AIAgentProviderStatus":{"id":"components/schemas/AIAgentProviderStatus","kind":"json-schema","title":"AIAgentProviderStatus","data":{"description":"The status of the AI agent provider","type":"string","enum":["ACTIVE","INACTIVE","REAUTHENTICATE","REVALIDATE"]}},"components/schemas/AIAgentProviders":{"id":"components/schemas/AIAgentProviders","kind":"json-schema","title":"AIAgentProviders","data":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/AIAgentProvider"}},"_links":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}},"required":["data","_links"]}},"components/schemas/AIAgentSchema":{"id":"components/schemas/AIAgentSchema","kind":"json-schema","title":"AIAgentSchema","data":{"description":"Defines the schema for AI agent profiles, including Okta-defined base attributes and org-defined custom attributes.","type":"object","properties":{"$schema":{"readOnly":true,"type":"string","description":"JSON schema version identifier"},"created":{"readOnly":true,"type":"string","format":"date-time","description":"Timestamp when the schema was created"},"definitions":{"$ref":"#/components/schemas/AIAgentSchemaDefinitions"},"description":{"type":"string","description":"Description for the schema"},"id":{"readOnly":true,"type":"string","description":"URI of AI Agent schema"},"lastUpdated":{"readOnly":true,"type":"string","format":"date-time","description":"Timestamp when the schema was last updated"},"name":{"readOnly":true,"type":"string","description":"Name of the schema"},"properties":{"type":"object","additionalProperties":true,"description":"AI Agent schema properties"},"title":{"type":"string","description":"Display name for the schema"},"type":{"readOnly":true,"type":"string","description":"Type of root schema"},"_links":{"$ref":"#/components/schemas/AIAgentSchemaLinks"}},"x-okta-allow-null-property-value-for-updates":true}},"components/schemas/AIAgentSchemaAttribute":{"id":"components/schemas/AIAgentSchemaAttribute","kind":"json-schema","title":"AIAgentSchemaAttribute","data":{"nullable":true,"x-okta-ignore-redocly-rules-for-sdk":true,"additionalProperties":true,"type":"object","properties":{"description":{"type":"string","description":"Description of the property"},"enum":{"items":{},"type":"array","nullable":true,"description":"Enumerated values of the property"},"master":{"type":"object","nullable":true,"description":"Defines the source of truth for the property value","properties":{"type":{"type":"string","description":"Determines the master source","enum":["PROFILE_MASTER","OKTA"]}}},"maxLength":{"type":"integer","nullable":true,"description":"Maximum character length of a string property"},"minLength":{"type":"integer","nullable":true,"description":"Minimum character length of a string property"},"mutability":{"type":"string","description":"Defines the mutability of the property","enum":["READ_ONLY","READ_WRITE","IMMUTABLE"]},"oneOf":{"items":{"type":"object","properties":{"const":{"description":"The enumerated value"},"title":{"type":"string","description":"The display name for the enum value"}}},"type":"array","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Non-empty array of valid JSON schemas."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" key is only supported in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and provides a mechanism to return a display name for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each schema has the following format:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"{"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"const\": \"enumValue\","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"\"title\": \"display name\""},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"}"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"enum"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used in conjunction with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oneOf"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must keep the set of enumerated values and their order."},"children":[]}]}]}]},"permissions":{"description":"Access control permissions for the property","items":{"$ref":"#/components/schemas/AIAgentSchemaAttributePermission"},"type":"array","nullable":true},"required":{"type":"boolean","nullable":true,"description":"Determines whether the property is required"},"scope":{"type":"string","nullable":true,"description":"Determines the property access scope","enum":["NONE","SELF","ANY"]},"title":{"type":"string","minLength":1,"description":"Display name for the property"},"type":{"type":"string","description":"Type of property","enum":["string","boolean","integer","number"]}}}},"components/schemas/AIAgentSchemaAttributePermission":{"id":"components/schemas/AIAgentSchemaAttributePermission","kind":"json-schema","title":"AIAgentSchemaAttributePermission","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"type":"object","properties":{"action":{"type":"string","description":"Allowed action for the property","enum":["READ_ONLY","READ_WRITE","HIDE"]},"principal":{"type":"string","description":"Security principal"}}}},"components/schemas/AIAgentSchemaBase":{"id":"components/schemas/AIAgentSchemaBase","kind":"json-schema","title":"AIAgentSchemaBase","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"type":"object","properties":{"id":{"readOnly":true,"type":"string","description":"The subschema name"},"properties":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#base"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object properties"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/AIAgentSchemaBaseProperties"}]},"required":{"items":{"type":"string"},"type":"array","description":"A collection that indicates required property names","readOnly":true},"type":{"description":"The object type","type":"string","readOnly":true}}}},"components/schemas/AIAgentSchemaBaseProperties":{"id":"components/schemas/AIAgentSchemaBaseProperties","kind":"json-schema","title":"AIAgentSchemaBaseProperties","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"description":"Okta-defined base profile properties for AI agents. These properties are predefined by Okta. You can't add or remove them, although you can set their attribute values on individual AI agents.","type":"object","properties":{"description":{"description":"Description of the AI agent","$ref":"#/components/schemas/AIAgentSchemaAttribute"},"externalId":{"description":"AI agent ID of the external platform","$ref":"#/components/schemas/AIAgentSchemaAttribute"},"name":{"description":"Name of the AI agent","$ref":"#/components/schemas/AIAgentSchemaAttribute"},"platform":{"description":"AI agent builder platform","$ref":"#/components/schemas/AIAgentSchemaAttribute"}}}},"components/schemas/AIAgentSchemaCustom":{"id":"components/schemas/AIAgentSchemaCustom","kind":"json-schema","title":"AIAgentSchemaCustom","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All custom profile properties are defined in a profile subschema with the resolution scope "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#custom"},"children":[]}]}]}],"type":"object","properties":{"id":{"readOnly":true,"type":"string","description":"The subschema name"},"properties":{"additionalProperties":{"$ref":"#/components/schemas/AIAgentSchemaAttribute"},"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"#custom"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object properties"},"children":[]}]}]}]},"required":{"items":{"type":"string"},"type":"array","description":"A collection that indicates required property names","readOnly":true},"type":{"type":"string","description":"The object type","readOnly":true}}}},"components/schemas/AIAgentSchemaDefinitions":{"id":"components/schemas/AIAgentSchemaDefinitions","kind":"json-schema","title":"AIAgentSchemaDefinitions","data":{"type":"object","properties":{"base":{"$ref":"#/components/schemas/AIAgentSchemaBase"},"custom":{"$ref":"#/components/schemas/AIAgentSchemaCustom"}}}},"components/schemas/AIAgentSchemaLinks":{"id":"components/schemas/AIAgentSchemaLinks","kind":"json-schema","title":"AIAgentSchemaLinks","data":{"type":"object","properties":{"self":{"type":"object","properties":{"href":{"type":"string","description":"Link URI"},"method":{"type":"string","description":"HTTP method for the link"},"rel":{"type":"string","description":"Link relation type"}}}}}},"components/schemas/AIAgentStaging":{"id":"components/schemas/AIAgentStaging","kind":"json-schema","title":"AIAgentStaging","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A staging item for an AI agent. When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUPLICATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incomingAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"existingAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are present."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IGNORED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"incomingAgent"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present."},"children":[]}]}]}],"type":"object","properties":{"existingAgent":{"$ref":"#/components/schemas/AIAgent"},"id":{"type":"string","description":"The ID of the staging item","example":"aic-1a2b3c4d"},"incomingAgent":{"$ref":"#/components/schemas/AIAgent"},"type":{"$ref":"#/components/schemas/AIAgentStagingType"}},"required":["id","type","incomingAgent"]}},"components/schemas/AIAgentStagingAttributeDifference":{"id":"components/schemas/AIAgentStagingAttributeDifference","kind":"json-schema","title":"AIAgentStagingAttributeDifference","data":{"description":"A comparison of a single attribute between the incoming and existing agent","type":"object","properties":{"attribute":{"type":"string","description":"The name of the compared attribute"},"existingValue":{"type":"string","nullable":true,"description":"The attribute value from the existing agent"},"incomingValue":{"type":"string","nullable":true,"description":"The attribute value from the incoming agent"},"status":{"$ref":"#/components/schemas/AIAgentStagingAttributeDifferenceStatus"}},"required":["attribute","status"]}},"components/schemas/AIAgentStagingAttributeDifferenceStatus":{"id":"components/schemas/AIAgentStagingAttributeDifferenceStatus","kind":"json-schema","title":"AIAgentStagingAttributeDifferenceStatus","data":{"description":"Whether the attribute values match or the incoming value overwrites the existing value on merge","type":"string","enum":["MATCH","OVERWRITING"]}},"components/schemas/AIAgentStagingBulkActionRequest":{"id":"components/schemas/AIAgentStagingBulkActionRequest","kind":"json-schema","title":"AIAgentStagingBulkActionRequest","data":{"description":"The request to perform an action on multiple staging items","type":"object","properties":{"ids":{"type":"array","description":"The IDs of the staging items to perform the action on","minItems":1,"maxItems":200,"items":{"type":"string"}}},"required":["ids"]}},"components/schemas/AIAgentStagingList":{"id":"components/schemas/AIAgentStagingList","kind":"json-schema","title":"AIAgentStagingList","data":{"type":"object","properties":{"data":{"type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/AIAgentStaging"}},"_links":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}},"required":["data","_links"]}},"components/schemas/AIAgentStagingReview":{"id":"components/schemas/AIAgentStagingReview","kind":"json-schema","title":"AIAgentStagingReview","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A detailed review of a duplicate staging item, including a side-by-side comparison of the incoming and existing agents. Only applicable for staging items of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUPLICATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"attributeDifferences":{"type":"array","description":"Field-level comparison between the incoming and existing agents","minItems":0,"items":{"$ref":"#/components/schemas/AIAgentStagingAttributeDifference"}},"existingAgent":{"$ref":"#/components/schemas/AIAgentStagingReviewAgent"},"incomingAgent":{"$ref":"#/components/schemas/AIAgentStagingReviewAgent"},"matchingCriteria":{"type":"string","description":"The evaluated result of the provider's deduplication expression that caused this duplicate match","example":"agent.profile.externalId eq 16jWe0000004jg5IAA and agent.profile.platform eq SALESFORCE_AGENTFORCE"},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of the staging item. Always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUPLICATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a staging review."},"children":[]}]}]}],"enum":["DUPLICATE"]}},"required":["type","matchingCriteria","incomingAgent","existingAgent","attributeDifferences"]}},"components/schemas/AIAgentStagingReviewAgent":{"id":"components/schemas/AIAgentStagingReviewAgent","kind":"json-schema","title":"AIAgentStagingReviewAgent","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An agent in the context of a staging review. The agent's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"profile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains both base and custom attributes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The agent's raw source data is available under "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"agent._embedded.sources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"agent":{"$ref":"#/components/schemas/AIAgent"},"sourceId":{"type":"string","description":"The ID of the specific source app instance (for example, Salesforce Production). The value is null for manually registered agents.","minLength":20,"maxLength":20},"sourcePriority":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The priority of the source. If merged, the agent from the higher-priority source provides the identity and attributes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value indicates no priority is assigned (typically for manually registered agents)."},"children":[]}]}]}],"minimum":1}},"required":["agent"]}},"components/schemas/AIAgentStagingStats":{"id":"components/schemas/AIAgentStagingStats","kind":"json-schema","title":"AIAgentStagingStats","data":{"description":"Staging item counts broken down by type for an AI agent provider","type":"object","properties":{"duplicateCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of staging items of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DUPLICATE"},"children":[]}]}]}],"minimum":0},"ignoredCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of staging items of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IGNORED"},"children":[]}]}]}],"minimum":0},"newCount":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The number of staging items of type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NEW"},"children":[]}]}]}],"minimum":0}},"required":["newCount","duplicateCount","ignoredCount"]}},"components/schemas/AIAgentStagingType":{"id":"components/schemas/AIAgentStagingType","kind":"json-schema","title":"AIAgentStagingType","data":{"description":"The staging item type","type":"string","enum":["DUPLICATE","IGNORED","NEW"]}},"components/schemas/AddVirtualMCPConnectionCapabilityRequest":{"id":"components/schemas/AddVirtualMCPConnectionCapabilityRequest","kind":"json-schema","title":"AddVirtualMCPConnectionCapabilityRequest","data":{"description":"Request to add a capability to a virtual MCP connection","type":"object","properties":{"alias":{"$ref":"#/components/schemas/VirtualMCPCapabilityAliasPatchable"},"sourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the source capability on the upstream resource server"},"children":[]}]}]}],"example":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k"}},"required":["sourceOrn"]}},"components/schemas/AgentClientSecret":{"id":"components/schemas/AgentClientSecret","kind":"json-schema","title":"AgentClientSecret","data":{"type":"object","properties":{"client_secret":{"type":"string","description":"The client secret string. Only returned in plaintext on creation.","example":"DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B","readOnly":true,"nullable":false},"created":{"type":"string","description":"Timestamp when the client secret was created","example":"2023-02-21T20:08:24.000Z","readOnly":true,"nullable":false},"id":{"type":"string","description":"The unique ID of the AI agent client secret","example":"ocs2f4zrZbs8nUa7p0g4","readOnly":true,"nullable":false},"lastUpdated":{"type":"string","description":"Timestamp when the client secret was last updated","example":"2023-02-21T20:08:24.000Z","readOnly":true,"nullable":false},"secret_hash":{"type":"string","description":"Hash of the client secret","example":"yk4SVx4sUWVJVbHt6M-UPA","readOnly":true,"nullable":false},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"description":"Status of the AI agent client secret","example":"ACTIVE","nullable":false,"default":"ACTIVE"},"_links":{"$ref":"#/components/schemas/AgentClientSecretLinks","readOnly":true,"nullable":false}}}},"components/schemas/AgentClientSecretLinks":{"id":"components/schemas/AgentClientSecretLinks","kind":"json-schema","title":"AgentClientSecretLinks","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies link relations available for the current status of an AI agent client secret using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Hypertext Application Language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification."},"children":[]}]}]}],"type":"object","properties":{"activate":{"$ref":"#/components/schemas/HrefObjectActivateLink"},"deactivate":{"$ref":"#/components/schemas/HrefObjectDeactivateLink"},"delete":{"$ref":"#/components/schemas/HrefObjectDeleteLink"}},"readOnly":true}},"components/schemas/AgentClientSecretRequestBody":{"id":"components/schemas/AgentClientSecretRequestBody","kind":"json-schema","title":"AgentClientSecretRequestBody","data":{"type":"object","properties":{"client_secret":{"type":"string","description":"The client secret string. If not provided, Okta generates a secure random secret.","example":"DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"description":"Status of the client secret","example":"ACTIVE"}}}},"components/schemas/AgentJsonSigningKeyCommon":{"id":"components/schemas/AgentJsonSigningKeyCommon","kind":"json-schema","title":"Signing Key","data":{"title":"Signing Key","type":"object","properties":{"alg":{"type":"string","description":"Algorithm that's used in the JSON Web Key","example":"RS256","nullable":false},"use":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Acceptable use of the JSON Web Key."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only use signing keys for AI agents, so the value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"use"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"sig","nullable":false,"enum":["sig"]}}}},"components/schemas/AgentJsonSigningKeyRequest":{"id":"components/schemas/AgentJsonSigningKeyRequest","kind":"json-schema","title":"Signing Key","data":{"title":"Signing Key","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A JSON Web Key (JWK) to add to the AI agent's JWK Set (JWKS). Supports RSA and EC key types, distinguished by the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"kty"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/AgentJsonWebKeyRsaRequest"},{"$ref":"#/components/schemas/AgentJsonWebKeyECRequest"}],"discriminator":{"propertyName":"kty","mapping":{"RSA":"#/components/schemas/AgentJsonWebKeyRsaRequest","EC":"#/components/schemas/AgentJsonWebKeyECRequest"}}}},"components/schemas/AgentJsonSigningKeyResponse":{"id":"components/schemas/AgentJsonSigningKeyResponse","kind":"json-schema","title":"Signing Key","data":{"title":"Signing Key","oneOf":[{"$ref":"#/components/schemas/AgentJsonWebKeyRsaResponse"},{"$ref":"#/components/schemas/AgentJsonWebKeyECResponse"}],"discriminator":{"propertyName":"kty","mapping":{"RSA":"#/components/schemas/AgentJsonWebKeyRsaResponse","EC":"#/components/schemas/AgentJsonWebKeyECResponse"}}}},"components/schemas/AgentJsonWebKeyECRequest":{"id":"components/schemas/AgentJsonWebKeyECRequest","kind":"json-schema","title":"EC Signing Key","data":{"title":"EC Signing Key","description":"An EC signing key","allOf":[{"$ref":"#/components/schemas/AgentJsonWebKeyRequestBase"},{"$ref":"#/components/schemas/AgentJsonSigningKeyCommon"}],"type":"object","properties":{"crv":{"type":"string","description":"The cryptographic curve that's used for the key pair","example":"P-256","nullable":false,"enum":["P-256","P-384","P-521"]},"kty":{"type":"string","description":"Cryptographic algorithm family for the certificate's key pair","example":"EC","nullable":false,"enum":["EC"]},"x":{"type":"string","description":"The public x coordinate for the elliptic curve point"},"y":{"type":"string","description":"The public y coordinate for the elliptic curve point"}},"required":["kty"]}},"components/schemas/AgentJsonWebKeyECResponse":{"id":"components/schemas/AgentJsonWebKeyECResponse","kind":"json-schema","title":"EC Signing Key","data":{"title":"EC Signing Key","description":"An EC signing key","allOf":[{"$ref":"#/components/schemas/AgentJsonWebKeyRequestBase"},{"$ref":"#/components/schemas/AgentJsonSigningKeyCommon"},{"$ref":"#/components/schemas/AgentJsonWebKeyResponseBase"}],"type":"object","properties":{"crv":{"type":"string","description":"The cryptographic curve that's used for the key pair","example":"P-256","nullable":false,"enum":["P-256","P-384","P-521"]},"kty":{"type":"string","description":"Cryptographic algorithm family for the certificate's key pair","example":"EC","nullable":false,"enum":["EC"]},"x":{"type":"string","description":"The public x coordinate for the elliptic curve point"},"y":{"type":"string","description":"The public y coordinate for the elliptic curve point"}},"required":["kty"]}},"components/schemas/AgentJsonWebKeyRequestBase":{"id":"components/schemas/AgentJsonWebKeyRequestBase","kind":"json-schema","title":"AgentJsonWebKeyRequestBase","data":{"type":"object","properties":{"kid":{"type":"string","description":"The unique identifier of the JSON Web Key in the AI agent's JSON Web Key Set (JWKS)","example":"SIMcCQNY3uwXoW3y0vf6VxiBb5n9pf8L2fK8d-FIbm4","nullable":false},"status":{"type":"string","enum":["ACTIVE","INACTIVE"],"description":"Status of the AI agent JSON Web Key","example":"ACTIVE","nullable":false,"default":"ACTIVE"}}}},"components/schemas/AgentJsonWebKeyResponseBase":{"id":"components/schemas/AgentJsonWebKeyResponseBase","kind":"json-schema","title":"AgentJsonWebKeyResponseBase","data":{"type":"object","properties":{"created":{"type":"string","description":"Timestamp of when the AI agent JSON Web Key was created","example":"2023-02-21T20:08:24.000Z","readOnly":true,"nullable":false},"id":{"type":"string","description":"The unique identifier of the AI agent JSON Web Key","example":"pks2f4zrZbs8nUa7p0g4","readOnly":true,"nullable":false},"lastUpdated":{"type":"string","description":"Timestamp of when the AI agent JSON Web Key was last updated","example":"2023-02-21T20:08:24.000Z","readOnly":true,"nullable":false},"_links":{"$ref":"#/components/schemas/AgentSecretLinks","readOnly":true,"nullable":false}}}},"components/schemas/AgentJsonWebKeyRsaRequest":{"id":"components/schemas/AgentJsonWebKeyRsaRequest","kind":"json-schema","title":"RSA Signing Key","data":{"title":"RSA Signing Key","description":"An RSA signing key","allOf":[{"$ref":"#/components/schemas/AgentJsonWebKeyRequestBase"},{"$ref":"#/components/schemas/AgentJsonSigningKeyCommon"}],"type":"object","properties":{"e":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The public exponent of the RSA key, represented as a Base64URL-encoded string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is used in combination with the modulus ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to verify signatures and encrypt data."},"children":[]}]}]}],"example":"AQAB","nullable":false},"kty":{"type":"string","description":"Cryptographic algorithm family for the certificate's key pair","example":"RSA","nullable":false,"enum":["RSA"]},"n":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modulus of the RSA public key, represented as a Base64URL-encoded string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the primary component of the RSA key and, with the exponent ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"e"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), is used for cryptographic signature verification and encryption."},"children":[]}]}]}],"example":"mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ","nullable":false}},"required":["kty"]}},"components/schemas/AgentJsonWebKeyRsaResponse":{"id":"components/schemas/AgentJsonWebKeyRsaResponse","kind":"json-schema","title":"RSA Signing Key","data":{"title":"RSA Signing Key","description":"An RSA signing key","allOf":[{"$ref":"#/components/schemas/AgentJsonWebKeyRequestBase"},{"$ref":"#/components/schemas/AgentJsonSigningKeyCommon"},{"$ref":"#/components/schemas/AgentJsonWebKeyResponseBase"}],"type":"object","properties":{"e":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The public exponent of the RSA key, represented as a Base64URL-encoded string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is used in combination with the modulus ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"n"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") to verify signatures and encrypt data."},"children":[]}]}]}],"example":"AQAB","nullable":false},"kty":{"type":"string","description":"Cryptographic algorithm family for the certificate's key pair","example":"RSA","nullable":false,"enum":["RSA"]},"n":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The modulus of the RSA public key, represented as a Base64URL-encoded string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This is the primary component of the RSA key and, with the exponent ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"e"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), is used for cryptographic signature verification and encryption."},"children":[]}]}]}],"example":"mkC6yAJVvFwUlmM9gKjb2d-YK5qHFt-mXSsbjWKKs4EfNm-BoQeeovBZtSACyaqLc8IYFTPEURFcbDQ9DkAL04uUIRD2gaHYY7uK0jsluEaXGq2RAIsmzAwNTzkiDw4q9pDL_q7n0f_SDt1TsMaMQayB6bU5jWsmqcWJ8MCRJ1aJMjZ16un5UVx51IIeCbe4QRDxEXGAvYNczsBoZxspDt28esSpq5W0dBFxcyGVudyl54Er3FzAguhgfMVjH-bUec9j2Tl40qDTktrYgYfxz9pfjm01Hl4WYP1YQxeETpSL7cQ5Ihz4jGDtHUEOcZ4GfJrPzrGpUrak8Qp5xcwCqQ","nullable":false}},"required":["kty"]}},"components/schemas/AgentJwksUriRequest":{"id":"components/schemas/AgentJwksUriRequest","kind":"json-schema","title":"AgentJwksUriRequest","data":{"description":"Request to store or update the external JWKS URI for an AI agent.","type":"object","properties":{"jwks_uri":{"type":"string","format":"uri","description":"URI of the external JWKS endpoint."}},"required":["jwks_uri"]}},"components/schemas/AgentJwksUriResponse":{"id":"components/schemas/AgentJwksUriResponse","kind":"json-schema","title":"AgentJwksUriResponse","data":{"type":"object","properties":{"jwks_uri":{"type":"string","format":"uri","description":"The stored JWKS URI."}}}},"components/schemas/AgentPublicKeyModeRequest":{"id":"components/schemas/AgentPublicKeyModeRequest","kind":"json-schema","title":"AgentPublicKeyModeRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request to set the active public key source mode for an AI agent. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JWKS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for inline JWK entries or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"JWKS_URI"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for an external JWKS endpoint."},"children":[]}]}]}],"type":"object","properties":{"mode":{"$ref":"#/components/schemas/secures-ai-workload-principals-components-schemas-agentpublickeymoderequest-type"}},"required":["mode"]}},"components/schemas/AgentPublicKeyModeResponse":{"id":"components/schemas/AgentPublicKeyModeResponse","kind":"json-schema","title":"AgentPublicKeyModeResponse","data":{"type":"object","properties":{"mode":{"$ref":"#/components/schemas/secures-ai-workload-principals-components-schemas-agentpublickeymoderequest-type"}}}},"components/schemas/AgentSecretLinks":{"id":"components/schemas/AgentSecretLinks","kind":"json-schema","title":"AgentSecretLinks","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies link relations (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8288"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web Linking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") available for the current status of an AI agent using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Hypertext Application Language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification. This object is used for dynamic discovery of related resources and lifecycle operations."},"children":[]}]}]}],"type":"object","properties":{"activate":{"$ref":"#/components/schemas/HrefObjectActivateLink"},"deactivate":{"$ref":"#/components/schemas/HrefObjectDeactivateLink"},"delete":{"$ref":"#/components/schemas/HrefObjectDeleteLink"}},"readOnly":true}},"components/schemas/AgentSettings":{"id":"components/schemas/AgentSettings","kind":"json-schema","title":"AgentSettings","data":{"type":"object","properties":{"features":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enabled feature indicators for this domain. Values might be added or removed without notice. Clients "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" build business logic that depends on the presence of specific values."},"children":[]}]}]}],"items":{"type":"string"}},"maxAgents":{"type":"integer","description":"Maximum number of AI agents allowed for this org"},"supportedConnectionTypes":{"type":"array","items":{"type":"string"}},"supportedPlatforms":{"type":"array","items":{"type":"string"}}}}},"components/schemas/ApiServerLinks":{"id":"components/schemas/ApiServerLinks","kind":"json-schema","title":"ApiServerLinks","data":{"description":"Specifies link relations available for the third-party API server","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the API server through the Okta API"}},"required":["self"]}},"components/schemas/ApiServerOrn":{"id":"components/schemas/ApiServerOrn","kind":"json-schema","title":"ApiServerOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the third-party API server"},"children":[]}]}]}],"type":"string"}},"components/schemas/AppInstanceLinks":{"id":"components/schemas/AppInstanceLinks","kind":"json-schema","title":"AppInstanceLinks","data":{"description":"Specifies link relations available for the app instance","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the app instance through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the app instance in the Admin Console"}},"required":["self"]}},"components/schemas/AppInstanceOrn":{"id":"components/schemas/AppInstanceOrn","kind":"json-schema","title":"AppInstanceOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the app instance"},"children":[]}]}]}],"type":"string"}},"components/schemas/AuthorizationServerLinks":{"id":"components/schemas/AuthorizationServerLinks","kind":"json-schema","title":"AuthorizationServerLinks","data":{"description":"Specifies link relations available for the authorization server","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the authorization server through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the authorization server in the Admin Console"}},"required":["self"]}},"components/schemas/AuthorizationServerOrn":{"id":"components/schemas/AuthorizationServerOrn","kind":"json-schema","title":"AuthorizationServerOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authorization server"},"children":[]}]}]}],"type":"string"}},"components/schemas/ClientAuthSettingsLinks":{"id":"components/schemas/ClientAuthSettingsLinks","kind":"json-schema","title":"ClientAuthSettingsLinks","data":{"description":"Specifies link relations available for the client authentication settings","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the client authentication settings through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the associated resource's configuration page in the Admin Console"}},"required":["self"]}},"components/schemas/ClientAuthSettingsOrn":{"id":"components/schemas/ClientAuthSettingsOrn","kind":"json-schema","title":"ClientAuthSettingsOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the client authentication settings"},"children":[]}]}]}],"type":"string"}},"components/schemas/Configuration":{"id":"components/schemas/Configuration","kind":"json-schema","title":"Configuration","data":{"additionalProperties":true,"type":"object"}},"components/schemas/ConnectionScopes":{"id":"components/schemas/ConnectionScopes","kind":"json-schema","title":"ConnectionScopes","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of scopes. Required for all "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopeCondition"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values."},"children":[]}]}]}],"minItems":1,"items":{"type":"string"},"type":"array"}},"components/schemas/ConnectionType":{"id":"components/schemas/ConnectionType","kind":"json-schema","title":"ConnectionType","data":{"description":"Type of connection authentication method","type":"string","enum":["IDENTITY_ASSERTION_CUSTOM_AS","STS_SERVICE_ACCOUNT","STS_VAULT_SECRET","STS_ACCESS_TOKEN","IDENTITY_ASSERTION_A2A_SERVER","IDENTITY_ASSERTION_APP_INSTANCE","IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER"],"x-enumDescriptions":{"STS_ACCESS_TOKEN":"Security Token Service connection for OAuth-based token exchange (app instances or third-party MCP servers)","IDENTITY_ASSERTION_A2A_SERVER":"Identity assertion connection for agent-to-agent (A2A) servers","IDENTITY_ASSERTION_CUSTOM_AS":"Identity assertion connection for custom authorization servers","IDENTITY_ASSERTION_APP_INSTANCE":"Identity assertion connection for an app instance","IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER":"Identity assertion connection for a virtual MCP server","STS_VAULT_SECRET":"Security Token Service connection for vaulted secrets","STS_SERVICE_ACCOUNT":"Security Token Service connection for service accounts"}}},"components/schemas/CreateAIAgentProviderRequest":{"id":"components/schemas/CreateAIAgentProviderRequest","kind":"json-schema","title":"CreateAIAgentProviderRequest","data":{"description":"The request to create an AI agent provider","type":"object","properties":{"configuration":{"$ref":"#/components/schemas/Configuration"},"owners":{"$ref":"#/components/schemas/Owners"},"sourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the source"},"children":[]}]}]}]},"schedule":{"$ref":"#/components/schemas/Schedule"}},"required":["sourceOrn","configuration"]}},"components/schemas/CreateAIAgentRequest":{"id":"components/schemas/CreateAIAgentRequest","kind":"json-schema","title":"CreateAIAgentRequest","data":{"type":"object","properties":{"appId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the connected app for the AI agent. Deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delegation Links API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"readOnly":false,"deprecated":true},"profile":{"$ref":"#/components/schemas/AIAgentProfile"},"resourceUrl":{"type":"string","description":"The resource URL for the agent-to-agent (A2A) server associated with this AI agent.\nWhen provided, an A2A resource server is automatically created for this agent.\nThis field is immutable after creation.","example":"https://demo-agent.example.com"},"signOnProvider":{"$ref":"#/components/schemas/WorkloadPrincipalSignOnProviderRequest"},"oauthClient":{"$ref":"#/components/schemas/WorkloadPrincipalOAuthClientCimdRequest"}},"required":["profile"]}},"components/schemas/CreateVirtualMCPRequest":{"id":"components/schemas/CreateVirtualMCPRequest","kind":"json-schema","title":"CreateVirtualMCPRequest","data":{"description":"Request to create a new virtual MCP","type":"object","properties":{"profile":{"type":"object","required":["displayName"],"properties":{"displayName":{"$ref":"#/components/schemas/VirtualMCPDisplayName"},"description":{"$ref":"#/components/schemas/VirtualMCPDescription"}}},"resourcePath":{"type":"string","description":"A URI path suffix that uniquely identifies this virtual MCP","pattern":"^[a-zA-Z0-9\\-._~]+$","minLength":1,"maxLength":64,"example":"production"}},"required":["resourcePath","profile"]}},"components/schemas/DelegationLink":{"id":"components/schemas/DelegationLink","kind":"json-schema","title":"DelegationLink","data":{"description":"A delegation link that defines a token source and target resource","type":"object","properties":{"from":{"$ref":"#/components/schemas/DelegationLinkFrom"},"id":{"type":"string","description":"Unique ID for the delegation link","readOnly":true},"to":{"$ref":"#/components/schemas/DelegationLinkTo"},"_embedded":{"$ref":"#/components/schemas/DelegationLinkEmbedded"}},"required":["id","from","to"]}},"components/schemas/DelegationLinkAgentMetadata":{"id":"components/schemas/DelegationLinkAgentMetadata","kind":"json-schema","title":"DelegationLinkAgentMetadata","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata about the AI agent referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only present when the request includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=agentMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" client is an AI agent (workload principal)."},"children":[]}]}]}],"additionalProperties":false,"type":"object","properties":{"name":{"type":"string","description":"The display name of the AI agent.","example":"Sales Agent"}}}},"components/schemas/DelegationLinkAppMetadata":{"id":"components/schemas/DelegationLinkAppMetadata","kind":"json-schema","title":"DelegationLinkAppMetadata","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata about the OAuth 2.0 client referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from.clientOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only present when the request includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=appMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" client is a publicly registered app. Individual fields are populated on a best-effort basis and may be absent when the underlying value is unknown or not publicly exposed for the given client."},"children":[]}]}]}],"additionalProperties":false,"type":"object","properties":{"applicationType":{"$ref":"#/components/schemas/OktaAuthorizationServerApplicationType"},"clientName":{"type":"string","description":"The display name of the client application.","example":"My OIDC App"},"grantTypes":{"type":"array","description":"The OAuth 2.0 grant types supported by the client application. Omitted when no public grant types apply.","items":{"$ref":"#/components/schemas/OktaAuthorizationServerGrantType"}}}}},"components/schemas/DelegationLinkCreatable":{"id":"components/schemas/DelegationLinkCreatable","kind":"json-schema","title":"DelegationLinkCreatable","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"description":"Create a new delegation link","type":"object","properties":{"from":{"$ref":"#/components/schemas/DelegationLinkFromCreatable"},"to":{"$ref":"#/components/schemas/DelegationLinkToCreatable"}},"required":["from","to"]}},"components/schemas/DelegationLinkCustomAuthorizationServerMetadata":{"id":"components/schemas/DelegationLinkCustomAuthorizationServerMetadata","kind":"json-schema","title":"DelegationLinkCustomAuthorizationServerMetadata","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Metadata about the custom authorization server referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to.authorizationServerOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Only present when the request includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand=customAuthorizationServerMetadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the link uses a custom authorization server (i.e. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"to.authorizationServerOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set)."},"children":[]}]}]}],"additionalProperties":false,"type":"object","properties":{"issuer":{"type":"string","description":"The issuer URL of the custom authorization server.","example":"https://example.okta.com/oauth2/aus1gjh63g214q0Hq0g4"},"name":{"type":"string","description":"The display name of the custom authorization server.","example":"My Custom Authorization Server"}}}},"components/schemas/DelegationLinkEmbedded":{"id":"components/schemas/DelegationLinkEmbedded","kind":"json-schema","title":"DelegationLinkEmbedded","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional data embedded on a delegation link via the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter. Each property is only present when the corresponding "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"expand"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value was requested and the underlying data exists for the link."},"children":[]}]}]}],"additionalProperties":false,"type":"object","properties":{"agentMetadata":{"$ref":"#/components/schemas/DelegationLinkAgentMetadata"},"appMetadata":{"$ref":"#/components/schemas/DelegationLinkAppMetadata"},"customAuthorizationServerMetadata":{"$ref":"#/components/schemas/DelegationLinkCustomAuthorizationServerMetadata"}}}},"components/schemas/DelegationLinkFrom":{"id":"components/schemas/DelegationLinkFrom","kind":"json-schema","title":"DelegationLinkFrom","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"oneOf":[{"$ref":"#/components/schemas/OktaAuthorizationServerDelegationLinkFrom"},{"$ref":"#/components/schemas/SamlApplicationDelegationLinkFrom"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"OKTA_AUTHORIZATION_SERVER":"#/components/schemas/OktaAuthorizationServerDelegationLinkFrom","SAML_APPLICATION":"#/components/schemas/SamlApplicationDelegationLinkFrom"}}}},"components/schemas/DelegationLinkFromCreatable":{"id":"components/schemas/DelegationLinkFromCreatable","kind":"json-schema","title":"DelegationLinkFromCreatable","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"oneOf":[{"$ref":"#/components/schemas/OktaAuthorizationServerDelegationLinkFromCreatable"},{"$ref":"#/components/schemas/SamlApplicationDelegationLinkFromCreatable"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"OKTA_AUTHORIZATION_SERVER":"#/components/schemas/OktaAuthorizationServerDelegationLinkFromCreatable","SAML_APPLICATION":"#/components/schemas/SamlApplicationDelegationLinkFromCreatable"}}}},"components/schemas/DelegationLinkList":{"id":"components/schemas/DelegationLinkList","kind":"json-schema","title":"DelegationLinkList","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"type":"object","properties":{"data":{"description":"All configured delegation links","type":"array","items":{"$ref":"#/components/schemas/DelegationLink"}},"_links":{"type":"object","description":"Links available in delegation link list response","required":["self"],"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}},"required":["data","_links"]}},"components/schemas/DelegationLinkTo":{"id":"components/schemas/DelegationLinkTo","kind":"json-schema","title":"DelegationLinkTo","data":{"description":"The target resource for the delegation link","additionalProperties":false,"type":"object","properties":{"authorizationServerOrn":{"type":"string","readOnly":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Resource Name (ORN)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authorization server for the target resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ACCESS_TOKEN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Always present. The custom authorization server that protects the target resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ID_TOKEN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Present if a custom authorization server was specified at creation time."},"children":[]}]}]}]}],"example":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"resourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Resource Name (ORN)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the target resource"},"children":[]}]}]}],"example":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"required":["resourceOrn"]}},"components/schemas/DelegationLinkToCreatable":{"id":"components/schemas/DelegationLinkToCreatable","kind":"json-schema","title":"DelegationLinkToCreatable","data":{"description":"The target resource for the delegation link","additionalProperties":false,"type":"object","properties":{"authorizationServerOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Resource Name (ORN)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the authorization server for the target resource. Only applicable for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ID_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delegation links. If omitted, defaults to the org authorization server. This can be set to any custom authorization server. This is ignored for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" delegation links."},"children":[]}]}]}],"example":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"resourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Resource Name (ORN)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the target resource"},"children":[]}]}]}],"example":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"required":["resourceOrn"]}},"components/schemas/DelegationLinkTokenType":{"id":"components/schemas/DelegationLinkTokenType","kind":"json-schema","title":"DelegationLinkTokenType","data":{"description":"The type of token accepted by the delegation link","type":"string","enum":["ACCESS_TOKEN","ID_TOKEN","SAML_ASSERTION"],"x-enumDescriptions":{"ID_TOKEN":"An OpenID Connect ID token","ACCESS_TOKEN":"An OAuth 2.0 access token","SAML_ASSERTION":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A SAML 2.0 assertion (for the SAML to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" step of Cross-App Access)"},"children":[]}]}]}]}}},"components/schemas/DelegationLinkWithLinks":{"id":"components/schemas/DelegationLinkWithLinks","kind":"json-schema","title":"DelegationLinkWithLinks","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A delegation link with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/DelegationLink"},{"type":"object","properties":{"_links":{"type":"object","description":"Links available in the delegation link response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink"}}}},"required":["_links"]}],"type":"object"}},"components/schemas/Error":{"id":"components/schemas/Error","kind":"json-schema","title":"Error","data":{"title":"Error","type":"object","properties":{"errorCauses":{"type":"array","items":{"$ref":"#/components/schemas/ErrorCause"}},"errorCode":{"type":"string","description":"An Okta code for this type of error"},"errorId":{"type":"string","description":"A unique identifier for this error. This can be used by Okta Support to help with troubleshooting."},"errorLink":{"type":"string","description":"An Okta code for this type of error"},"errorSummary":{"type":"string","description":"A short description of what caused this error. Sometimes this contains dynamically-generated information about your specific error."}}}},"components/schemas/ErrorCause":{"id":"components/schemas/ErrorCause","kind":"json-schema","title":"ErrorCause","data":{"type":"object","properties":{"errorSummary":{"type":"string"}}}},"components/schemas/ErrorDetails":{"id":"components/schemas/ErrorDetails","kind":"json-schema","title":"ErrorDetails","data":{"description":"Details about an error that occurred during the operation","type":"object","properties":{"code":{"type":"string","description":"The error code"},"message":{"type":"string","description":"The error message"}}}},"components/schemas/HrefHints":{"id":"components/schemas/HrefHints","kind":"json-schema","title":"HrefHints","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Describes allowed HTTP verbs for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]}]}]}],"type":"object","properties":{"allow":{"type":"array","items":{"$ref":"#/components/schemas/HttpMethod"}}}}},"components/schemas/HrefObject":{"id":"components/schemas/HrefObject","kind":"json-schema","title":"Link Object","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"title":"Link Object","additionalProperties":true,"type":"object","properties":{"hints":{"$ref":"#/components/schemas/HrefHints","readOnly":true},"href":{"type":"string","description":"Link URI"},"name":{"type":"string","description":"Link name","readOnly":true},"templated":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates whether the link object's "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"href"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is a URI template."},"children":[]}]}]}],"readOnly":true},"type":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The media type of the link. If omitted, it is implicitly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true}},"required":["href"]}},"components/schemas/HrefObjectActivateLink":{"id":"components/schemas/HrefObjectActivateLink","kind":"json-schema","title":"HrefObjectActivateLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to activate the resource"}]}},"components/schemas/HrefObjectAppLink":{"id":"components/schemas/HrefObjectAppLink","kind":"json-schema","title":"HrefObjectAppLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the app resource"}]}},"components/schemas/HrefObjectAssigneeLink":{"id":"components/schemas/HrefObjectAssigneeLink","kind":"json-schema","title":"HrefObjectAssigneeLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the assignee resource"}]}},"components/schemas/HrefObjectBindingLink":{"id":"components/schemas/HrefObjectBindingLink","kind":"json-schema","title":"HrefObjectBindingLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the binding resource"}]}},"components/schemas/HrefObjectBindingsLink":{"id":"components/schemas/HrefObjectBindingsLink","kind":"json-schema","title":"HrefObjectBindingsLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the bindings resource"}]}},"components/schemas/HrefObjectClientLink":{"id":"components/schemas/HrefObjectClientLink","kind":"json-schema","title":"HrefObjectClientLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the client resource"}]}},"components/schemas/HrefObjectDeactivateLink":{"id":"components/schemas/HrefObjectDeactivateLink","kind":"json-schema","title":"HrefObjectDeactivateLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to deactivate the resource"}]}},"components/schemas/HrefObjectDelegationLinksLink":{"id":"components/schemas/HrefObjectDelegationLinksLink","kind":"json-schema","title":"HrefObjectDelegationLinksLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to delegation links for the AI agent"}]}},"components/schemas/HrefObjectDeleteLink":{"id":"components/schemas/HrefObjectDeleteLink","kind":"json-schema","title":"HrefObjectDeleteLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to delete the resource"}]}},"components/schemas/HrefObjectGroupLink":{"id":"components/schemas/HrefObjectGroupLink","kind":"json-schema","title":"HrefObjectGroupLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the group resource"}]}},"components/schemas/HrefObjectLogoLink":{"id":"components/schemas/HrefObjectLogoLink","kind":"json-schema","title":"HrefObjectLogoLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the logo resource"}]}},"components/schemas/HrefObjectMappingsLink":{"id":"components/schemas/HrefObjectMappingsLink","kind":"json-schema","title":"HrefObjectMappingsLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the mappings resource"}]}},"components/schemas/HrefObjectMemberLink":{"id":"components/schemas/HrefObjectMemberLink","kind":"json-schema","title":"HrefObjectMemberLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the member resource"}]}},"components/schemas/HrefObjectMembersLink":{"id":"components/schemas/HrefObjectMembersLink","kind":"json-schema","title":"HrefObjectMembersLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the members resource"}]}},"components/schemas/HrefObjectNextLink":{"id":"components/schemas/HrefObjectNextLink","kind":"json-schema","title":"HrefObjectNextLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the next resource"}]}},"components/schemas/HrefObjectPermissionsLink":{"id":"components/schemas/HrefObjectPermissionsLink","kind":"json-schema","title":"HrefObjectPermissionsLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the permissions resource"}]}},"components/schemas/HrefObjectProviderLink":{"id":"components/schemas/HrefObjectProviderLink","kind":"json-schema","title":"HrefObjectProviderLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to a provider"}],"type":"object"}},"components/schemas/HrefObjectResourceSetLink":{"id":"components/schemas/HrefObjectResourceSetLink","kind":"json-schema","title":"HrefObjectResourceSetLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the resource set resource"}]}},"components/schemas/HrefObjectResourceSetResourcesLink":{"id":"components/schemas/HrefObjectResourceSetResourcesLink","kind":"json-schema","title":"HrefObjectResourceSetResourcesLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to resource set resources"}]}},"components/schemas/HrefObjectRoleLink":{"id":"components/schemas/HrefObjectRoleLink","kind":"json-schema","title":"HrefObjectRoleLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the role resource"}]}},"components/schemas/HrefObjectRulesLink":{"id":"components/schemas/HrefObjectRulesLink","kind":"json-schema","title":"HrefObjectRulesLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the rules resource"}]}},"components/schemas/HrefObjectSelfLink":{"id":"components/schemas/HrefObjectSelfLink","kind":"json-schema","title":"HrefObjectSelfLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the resource (self)"}]}},"components/schemas/HrefObjectSuspendLink":{"id":"components/schemas/HrefObjectSuspendLink","kind":"json-schema","title":"HrefObjectSuspendLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to suspend the resource"}]}},"components/schemas/HrefObjectUnsuspendLink":{"id":"components/schemas/HrefObjectUnsuspendLink","kind":"json-schema","title":"HrefObjectUnsuspendLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to unsuspend the resource"}]}},"components/schemas/HrefObjectUserLink":{"id":"components/schemas/HrefObjectUserLink","kind":"json-schema","title":"HrefObjectUserLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the user resource"}]}},"components/schemas/HrefObjectWebLink":{"id":"components/schemas/HrefObjectWebLink","kind":"json-schema","title":"HrefObjectWebLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the resource in the Okta Admin Console"}]}},"components/schemas/HttpMethod":{"id":"components/schemas/HttpMethod","kind":"json-schema","title":"HttpMethod","data":{"type":"string","enum":["DELETE","GET","POST","PUT"]}},"components/schemas/IdentityAssertionA2AServerConnection":{"id":"components/schemas/IdentityAssertionA2AServerConnection","kind":"json-schema","title":"IdentityAssertionA2AServerConnection","data":{"description":"Identity assertion connection for an agent-to-agent (A2A) server","additionalProperties":false,"type":"object","properties":{"authorizationServer":{"$ref":"#/components/schemas/ResourceConnectionCustomAuthorizationServer"},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_A2A_SERVER"],"description":"Type of connection authentication method"},"id":{"$ref":"#/components/schemas/ResourceConnectionId"},"orn":{"$ref":"#/components/schemas/ResourceConnectionOrn"},"resource":{"$ref":"#/components/schemas/ResourceConnectionA2aServer"},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"},"status":{"$ref":"#/components/schemas/ResourceConnectionStatus"},"_links":{"$ref":"#/components/schemas/ResourceConnectionLinks"}},"required":["connectionType","resource","authorizationServer","id","orn","status","_links"]}},"components/schemas/IdentityAssertionA2AServerConnectionCreatable":{"id":"components/schemas/IdentityAssertionA2AServerConnectionCreatable","kind":"json-schema","title":"IdentityAssertionA2AServerConnectionCreatable","data":{"description":"Create an identity assertion connection for an agent-to-agent (A2A) server","type":"object","properties":{"authorizationServer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to an authorization server in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/AuthorizationServerOrn"}}},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_A2A_SERVER"],"description":"Type of connection authentication method"},"resource":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to an agent-to-agent (A2A) server in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/A2aServerOrn"}}},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"}},"required":["connectionType","resource","authorizationServer","scopeCondition","scopes"]}},"components/schemas/IdentityAssertionAppInstanceConnection":{"id":"components/schemas/IdentityAssertionAppInstanceConnection","kind":"json-schema","title":"IdentityAssertionAppInstanceConnection","data":{"description":"An identity assertion connection that targets an app instance","additionalProperties":false,"type":"object","properties":{"appInstance":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The target app instance in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format, together with a human-readable name"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/AppInstanceOrn"},"name":{"type":"string","description":"Human-readable label of the app instance, surfaced in lists in the Admin Console"}}},"clientIdAtResource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OAuth client identifier that the agent is registered as to the partner authorization server. Written to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim of the issued identity assertion."},"children":[]}]}]}]},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_APP_INSTANCE"],"description":"Type of connection authentication method"},"id":{"$ref":"#/components/schemas/ResourceConnectionId"},"orn":{"$ref":"#/components/schemas/ResourceConnectionOrn"},"resourceIndicator":{"$ref":"#/components/schemas/ResourceConnectionResourceIndicator"},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"},"status":{"$ref":"#/components/schemas/ResourceConnectionStatus"},"_links":{"$ref":"#/components/schemas/ResourceConnectionLinks"}},"required":["connectionType","appInstance","clientIdAtResource","id","orn","status","resourceIndicator","_links"]}},"components/schemas/IdentityAssertionAppInstanceConnectionCreatable":{"id":"components/schemas/IdentityAssertionAppInstanceConnectionCreatable","kind":"json-schema","title":"IdentityAssertionAppInstanceConnectionCreatable","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an identity assertion connection that targets an app instance. The referenced app instance determines the user identifier written to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sub"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim of the issued identity assertion."},"children":[]}]}]}],"type":"object","properties":{"appInstance":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to the target app instance in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/AppInstanceOrn"}}},"clientIdAtResource":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The OAuth client identifier that the agent is registered as to the partner authorization server. Written to the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" claim of the issued identity assertion."},"children":[]}]}]}]},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_APP_INSTANCE"],"description":"Type of connection authentication method"},"resourceIndicator":{"type":"string","format":"uri","description":"Resource indicator used when requesting tokens. Defaults to an empty string."},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"}},"required":["connectionType","appInstance","clientIdAtResource"]}},"components/schemas/IdentityAssertionCustomASConnection":{"id":"components/schemas/IdentityAssertionCustomASConnection","kind":"json-schema","title":"IdentityAssertionCustomASConnection","data":{"description":"Identity assertion connection for a custom authorization server","additionalProperties":false,"type":"object","properties":{"authorizationServer":{"$ref":"#/components/schemas/ResourceConnectionCustomAuthorizationServer"},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_CUSTOM_AS"],"description":"Type of connection authentication method"},"id":{"$ref":"#/components/schemas/ResourceConnectionId"},"orn":{"$ref":"#/components/schemas/ResourceConnectionOrn"},"resourceIndicator":{"$ref":"#/components/schemas/ResourceConnectionResourceIndicator"},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"},"status":{"$ref":"#/components/schemas/ResourceConnectionStatus"},"_links":{"$ref":"#/components/schemas/ResourceConnectionLinks"}},"required":["connectionType","authorizationServer","resourceIndicator","id","orn","status","_links"]}},"components/schemas/IdentityAssertionCustomASConnectionCreatable":{"id":"components/schemas/IdentityAssertionCustomASConnectionCreatable","kind":"json-schema","title":"IdentityAssertionCustomASConnectionCreatable","data":{"description":"Create an identity assertion connection for a custom authorization server","type":"object","properties":{"authorizationServer":{"type":"object","description":"Reference to a custom authorization server and its configuration","required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/AuthorizationServerOrn"}}},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_CUSTOM_AS"],"description":"Type of connection authentication method"},"resourceIndicator":{"type":"string","format":"uri","description":"Resource indicator used when requesting tokens. Defaults to the authorization server's ORN if not specified."},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"}},"required":["connectionType","authorizationServer","scopeCondition","scopes"]}},"components/schemas/IdentityAssertionVirtualMcpServerConnection":{"id":"components/schemas/IdentityAssertionVirtualMcpServerConnection","kind":"json-schema","title":"IdentityAssertionVirtualMcpServerConnection","data":{"description":"Identity assertion connection for a virtual MCP server","additionalProperties":false,"type":"object","properties":{"authorizationServer":{"$ref":"#/components/schemas/ResourceConnectionCustomAuthorizationServer"},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER"],"description":"Type of connection authentication method"},"id":{"$ref":"#/components/schemas/ResourceConnectionId"},"orn":{"$ref":"#/components/schemas/ResourceConnectionOrn"},"resource":{"$ref":"#/components/schemas/ResourceConnectionVirtualMcpServer"},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"},"status":{"$ref":"#/components/schemas/ResourceConnectionStatus"},"_links":{"$ref":"#/components/schemas/ResourceConnectionLinks"}},"required":["connectionType","resource","authorizationServer","id","orn","status","_links"]}},"components/schemas/IdentityAssertionVirtualMcpServerConnectionCreatable":{"id":"components/schemas/IdentityAssertionVirtualMcpServerConnectionCreatable","kind":"json-schema","title":"IdentityAssertionVirtualMcpServerConnectionCreatable","data":{"description":"Create an identity assertion connection for a virtual MCP server","type":"object","properties":{"authorizationServer":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to an authorization server in the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/AuthorizationServerOrn"}}},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER"],"description":"Type of connection authentication method"},"resource":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to a virtual MCP server in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/VirtualMcpServerOrn"}}},"scopeCondition":{"$ref":"#/components/schemas/ScopeCondition"},"scopes":{"$ref":"#/components/schemas/ConnectionScopes"}},"required":["connectionType","resource","authorizationServer","scopeCondition","scopes"]}},"components/schemas/LinksNext":{"id":"components/schemas/LinksNext","kind":"json-schema","title":"LinksNext","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies link relations (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8288"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web Linking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") available for the current status of an application using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Hypertext Application Language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LinksNext"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object for dynamic discovery of related resources and lifecycle operations."},"children":[]}]}]}],"type":"object","properties":{"next":{"$ref":"#/components/schemas/HrefObjectNextLink"}},"readOnly":true}},"components/schemas/LinksProviders":{"id":"components/schemas/LinksProviders","kind":"json-schema","title":"LinksProviders","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies link relations (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8288"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web Linking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") available using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Hypertext Application Language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification. This object is used for dynamic discovery of related resources and lifecycle operations."},"children":[]}]}]}],"type":"object","properties":{"providers":{"type":"array","items":{"$ref":"#/components/schemas/HrefObjectProviderLink"}}},"readOnly":true}},"components/schemas/LinksSelf":{"id":"components/schemas/LinksSelf","kind":"json-schema","title":"LinksSelf","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies link relations (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc8288"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Web Linking"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") available using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://datatracker.ietf.org/doc/html/draft-kelly-json-hal-06"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"JSON Hypertext Application Language"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" specification. This object is used for dynamic discovery of related resources and lifecycle operations."},"children":[]}]}]}],"type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink"}},"readOnly":true}},"components/schemas/LinksSelfAndLifecycle":{"id":"components/schemas/LinksSelfAndLifecycle","kind":"json-schema","title":"LinksSelfAndLifecycle","data":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"type":"object","properties":{"activate":{"$ref":"#/components/schemas/HrefObjectActivateLink"},"deactivate":{"$ref":"#/components/schemas/HrefObjectDeactivateLink"}}}]}},"components/schemas/ManagedSTSAccessTokenApiServerResourceData":{"id":"components/schemas/ManagedSTSAccessTokenApiServerResourceData","kind":"json-schema","title":"ManagedSTSAccessTokenApiServerResourceData","data":{"description":"Resource data for an STS access token connection to a third-party API server","type":"object","properties":{"apiServerId":{"type":"string","description":"ID of the associated third-party API server"},"clientAuthSettings":{"$ref":"#/components/schemas/ResourceConnectionClientAuthSettings"},"name":{"type":"string","description":"Display name of the third-party API server"},"orn":{"$ref":"#/components/schemas/ApiServerOrn"},"resourceType":{"type":"string","enum":["API_SERVER"],"description":"Type of resource for this STS access token connection"},"resourceUrl":{"type":"string","format":"uri","description":"URL of the third-party API server"},"_links":{"$ref":"#/components/schemas/ApiServerLinks"}},"required":["resourceType","orn","apiServerId","clientAuthSettings","_links"]}},"components/schemas/ManagedSTSAccessTokenAppInstanceResourceData":{"id":"components/schemas/ManagedSTSAccessTokenAppInstanceResourceData","kind":"json-schema","title":"ManagedSTSAccessTokenAppInstanceResourceData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource data for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection to an app instance"},"children":[]}]}]}],"type":"object","properties":{"appInstanceId":{"type":"string","description":"ID of the associated app instance"},"appInstanceName":{"type":"string","description":"Display name of the associated app instance"},"clientAuthSettings":{"$ref":"#/components/schemas/ResourceConnectionClientAuthSettings"},"logo":{"type":"string","description":"Image URL for the app logo"},"orn":{"$ref":"#/components/schemas/AppInstanceOrn"},"resourceType":{"type":"string","enum":["APP_INSTANCE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of resource for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection"},"children":[]}]}]}]},"_links":{"$ref":"#/components/schemas/AppInstanceLinks"}},"required":["resourceType","orn","appInstanceId","appInstanceName","clientAuthSettings","_links"]}},"components/schemas/ManagedSTSAccessTokenMcpServerResourceData":{"id":"components/schemas/ManagedSTSAccessTokenMcpServerResourceData","kind":"json-schema","title":"ManagedSTSAccessTokenMcpServerResourceData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource data for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection to a third-party MCP server"},"children":[]}]}]}],"type":"object","properties":{"clientAuthSettings":{"$ref":"#/components/schemas/ResourceConnectionClientAuthSettings"},"endpointUrl":{"type":"string","description":"Endpoint URL of the third-party MCP server"},"mcpServerId":{"type":"string","description":"ID of the associated third-party MCP server"},"name":{"type":"string","description":"Display name of the third-party MCP server"},"orn":{"$ref":"#/components/schemas/McpServerOrn"},"resourceType":{"type":"string","enum":["MCP_SERVER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of resource for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection"},"children":[]}]}]}]},"_links":{"$ref":"#/components/schemas/McpServerLinks"}},"required":["resourceType","orn","mcpServerId","clientAuthSettings","_links"]}},"components/schemas/ManagedSTSAccessTokenResourceData":{"id":"components/schemas/ManagedSTSAccessTokenResourceData","kind":"json-schema","title":"ManagedSTSAccessTokenResourceData","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"oneOf":[{"$ref":"#/components/schemas/ManagedSTSAccessTokenAppInstanceResourceData"},{"$ref":"#/components/schemas/ManagedSTSAccessTokenMcpServerResourceData"},{"$ref":"#/components/schemas/ManagedSTSAccessTokenApiServerResourceData"}],"type":"object","discriminator":{"propertyName":"resourceType","mapping":{"APP_INSTANCE":"#/components/schemas/ManagedSTSAccessTokenAppInstanceResourceData","MCP_SERVER":"#/components/schemas/ManagedSTSAccessTokenMcpServerResourceData","API_SERVER":"#/components/schemas/ManagedSTSAccessTokenApiServerResourceData"}}}},"components/schemas/McpServerLinks":{"id":"components/schemas/McpServerLinks","kind":"json-schema","title":"McpServerLinks","data":{"description":"Specifies link relations available for the third-party MCP server","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the third-party MCP server through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the third-party MCP server in the Admin Console"}},"required":["self"]}},"components/schemas/McpServerOrn":{"id":"components/schemas/McpServerOrn","kind":"json-schema","title":"McpServerOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the third-party MCP server"},"children":[]}]}]}],"type":"string"}},"components/schemas/OktaAuthorizationServerApplicationType":{"id":"components/schemas/OktaAuthorizationServerApplicationType","kind":"json-schema","title":"OktaAuthorizationServerApplicationType","data":{"description":"The type of an OAuth 2.0 / OpenID Connect client application","type":"string","enum":["native","service","spa","web"]}},"components/schemas/OktaAuthorizationServerDelegationLinkFrom":{"id":"components/schemas/OktaAuthorizationServerDelegationLinkFrom","kind":"json-schema","title":"OktaAuthorizationServerDelegationLinkFrom","data":{"description":"A token source from an Okta authorization server","additionalProperties":false,"type":"object","properties":{"clientOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Resource Name (ORN)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the OAuth 2.0 client whose tokens are accepted"},"children":[]}]}]}],"example":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ"},"tokenType":{"$ref":"#/components/schemas/DelegationLinkTokenType"},"type":{"type":"string","description":"The type of token source","enum":["OKTA_AUTHORIZATION_SERVER"]}},"required":["type","clientOrn","tokenType"]}},"components/schemas/OktaAuthorizationServerDelegationLinkFromCreatable":{"id":"components/schemas/OktaAuthorizationServerDelegationLinkFromCreatable","kind":"json-schema","title":"OktaAuthorizationServerDelegationLinkFromCreatable","data":{"description":"Create a delegation link from an Okta authorization server","additionalProperties":false,"type":"object","properties":{"clientOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Resource Name (ORN)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the OAuth 2.0 client whose tokens are accepted"},"children":[]}]}]}],"example":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ"},"tokenType":{"$ref":"#/components/schemas/DelegationLinkTokenType"},"type":{"type":"string","description":"The type of token source","enum":["OKTA_AUTHORIZATION_SERVER"]}},"required":["type","clientOrn","tokenType"]}},"components/schemas/OktaAuthorizationServerGrantType":{"id":"components/schemas/OktaAuthorizationServerGrantType","kind":"json-schema","title":"OktaAuthorizationServerGrantType","data":{"description":"An OAuth 2.0 / OpenID Connect grant type supported by a client application. Limited to grant types that are part of the public OAuth 2.0 / OpenID Connect contract; internal-only grant types are excluded.","type":"string","enum":["authorization_code","client_credentials","implicit","interaction_code","password","refresh_token","urn:ietf:params:oauth:grant-type:device_code","urn:ietf:params:oauth:grant-type:jwt-bearer","urn:ietf:params:oauth:grant-type:saml2-bearer","urn:ietf:params:oauth:grant-type:token-exchange","urn:openid:params:grant-type:ciba"]}},"components/schemas/Owners":{"id":"components/schemas/Owners","kind":"json-schema","title":"Owners","data":{"type":"object","properties":{"groupOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource-owner group "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]}]}]}]},"userOrns":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of resource-owner user "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORNs"},"children":[]}]}]}]}],"minItems":1,"maxItems":5,"items":{"type":"string"}}}}},"components/schemas/PatchAIAgentProfile":{"id":"components/schemas/PatchAIAgentProfile","kind":"json-schema","title":"PatchAIAgentProfile","data":{"description":"Partial update for AI agent profile","type":"object","properties":{"description":{"type":"string","description":"Description of the AI agent","maxLength":1024,"nullable":true},"name":{"type":"string","description":"Unique name of the AI agent","minLength":3,"maxLength":100,"nullable":true}}}},"components/schemas/PatchAIAgentProviderDeDupExpression":{"id":"components/schemas/PatchAIAgentProviderDeDupExpression","kind":"json-schema","title":"PatchAIAgentProviderDeDupExpression","data":{"description":"Expression to uniquely identify imported agents. If not provided, the default behavior is to use the agent's external ID as the unique identifier. Custom values beyond the listed enum are also accepted.","example":"target.profile.externalId eq source.profile.externalId","nullable":true,"type":"string","enum":["target.profile.externalId eq source.profile.externalId","target.profile.externalId eq source.profile.externalId and target.profile.platform eq source.profile.platform","target.profile.externalId eq source.profile.externalId and target.profile.name eq source.profile.name","target.profile.externalId eq source.profile.externalId and target.profile.name eq source.profile.name and target.profile.platform eq source.profile.platform"]}},"components/schemas/PatchAIAgentProviderStage":{"id":"components/schemas/PatchAIAgentProviderStage","kind":"json-schema","title":"PatchAIAgentProviderStage","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Preview option to unify identity for imported agents. If not provided, the default behavior is to import agents as AUTO_MERGE."},"children":[]}]}]}],"nullable":true,"type":"string","enum":["AUTO_MERGE","DUPLICATE","NEWLY_IMPORTED"]}},"components/schemas/PatchAIAgentRequest":{"id":"components/schemas/PatchAIAgentRequest","kind":"json-schema","title":"PatchAIAgentRequest","data":{"description":"JSON Merge Patch for AI agent","type":"object","properties":{"appId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the connected app for the AI agent. Deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delegation Links API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"nullable":true,"deprecated":true},"profile":{"$ref":"#/components/schemas/PatchAIAgentProfile"},"resourceUrl":{"type":"string","nullable":true,"description":"The resource URL for the agent-to-agent (A2A) server that is associated with this AI agent.\nWhen provided, an A2A resource server is automatically created for this agent.\nThis field can only be set once, and only for agents that don't already have an associated A2A server.","example":"https://demo-agent.example.com"},"signOnProvider":{"$ref":"#/components/schemas/PatchWorkloadPrincipalSignOnProviderRequest"}}}},"components/schemas/PatchVirtualMCPRequest":{"id":"components/schemas/PatchVirtualMCPRequest","kind":"json-schema","title":"PatchVirtualMCPRequest","data":{"description":"JSON Merge Patch for virtual MCP","type":"object","properties":{"profile":{"type":"object","properties":{"displayName":{"type":"string","description":"Human-readable display name for the virtual MCP","minLength":1,"maxLength":255,"example":"Production MCP Servers"},"description":{"type":"string","nullable":true,"description":"Description of the virtual MCP","minLength":1,"maxLength":2000,"example":"Groups all production MCP servers for the engineering team"}}}}}},"components/schemas/PatchWorkloadPrincipalSignOnProviderRequest":{"id":"components/schemas/PatchWorkloadPrincipalSignOnProviderRequest","kind":"json-schema","title":"PatchWorkloadPrincipalSignOnProviderRequest","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sign-on provider to bind to the AI agent. Cannot be set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" if provided — omit the field instead to leave the binding unchanged."},"children":[]}]}]}],"oneOf":[{"$ref":"#/components/schemas/WorkloadPrincipalSignOnProviderNewOidcApp"},{"$ref":"#/components/schemas/WorkloadPrincipalSignOnProviderExistingApp"}],"type":"object","discriminator":{"propertyName":"type","mapping":{"NEW_OIDC_APP":"#/components/schemas/WorkloadPrincipalSignOnProviderNewOidcApp","EXISTING_APP":"#/components/schemas/WorkloadPrincipalSignOnProviderExistingApp"}}}},"components/schemas/PotentialConnection":{"id":"components/schemas/PotentialConnection","kind":"json-schema","title":"PotentialConnection","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"oneOf":[{"$ref":"#/components/schemas/PotentialIdentityAssertionCustomASConnection"},{"$ref":"#/components/schemas/PotentialSTSVaultSecretConnection"},{"$ref":"#/components/schemas/PotentialSTSServiceAccountConnection"},{"$ref":"#/components/schemas/PotentialSTSAccessTokenConnection"},{"$ref":"#/components/schemas/PotentialIdentityAssertionA2AServerConnection"},{"$ref":"#/components/schemas/PotentialIdentityAssertionAppInstanceConnection"},{"$ref":"#/components/schemas/PotentialIdentityAssertionVirtualMcpServerConnection"}],"type":"object","discriminator":{"propertyName":"connectionType","mapping":{"IDENTITY_ASSERTION_CUSTOM_AS":"#/components/schemas/PotentialIdentityAssertionCustomASConnection","STS_VAULT_SECRET":"#/components/schemas/PotentialSTSVaultSecretConnection","STS_SERVICE_ACCOUNT":"#/components/schemas/PotentialSTSServiceAccountConnection","STS_ACCESS_TOKEN":"#/components/schemas/PotentialSTSAccessTokenConnection","IDENTITY_ASSERTION_A2A_SERVER":"#/components/schemas/PotentialIdentityAssertionA2AServerConnection","IDENTITY_ASSERTION_APP_INSTANCE":"#/components/schemas/PotentialIdentityAssertionAppInstanceConnection","IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER":"#/components/schemas/PotentialIdentityAssertionVirtualMcpServerConnection"}}}},"components/schemas/PotentialConnectionA2aServer":{"id":"components/schemas/PotentialConnectionA2aServer","kind":"json-schema","title":"PotentialConnectionA2aServer","data":{"description":"Agent-to-agent (A2A) server for a potential connection","type":"object","properties":{"name":{"type":"string","description":"Display name of the agent-to-agent (A2A) server"},"orn":{"$ref":"#/components/schemas/A2aServerOrn"},"_links":{"$ref":"#/components/schemas/A2aServerLinks"}},"required":["orn","name","_links"]}},"components/schemas/PotentialConnectionAppInstance":{"id":"components/schemas/PotentialConnectionAppInstance","kind":"json-schema","title":"PotentialConnectionAppInstance","data":{"description":"App instance for a potential connection","type":"object","properties":{"logo":{"type":"string","description":"Image URL for the app logo"},"name":{"type":"string","description":"Display name of the app"},"orn":{"$ref":"#/components/schemas/AppInstanceOrn"},"_links":{"$ref":"#/components/schemas/AppInstanceLinks"}},"required":["orn","name","_links"]}},"components/schemas/PotentialConnectionCustomAuthorizationServer":{"id":"components/schemas/PotentialConnectionCustomAuthorizationServer","kind":"json-schema","title":"PotentialConnectionCustomAuthorizationServer","data":{"description":"Custom authorization server for a potential connection","type":"object","properties":{"issuerUrl":{"type":"string","description":"Issuer URL for the authorization server"},"logo":{"type":"string","description":"Image URL for the authorization server"},"name":{"type":"string","description":"Display name of the authorization server"},"orn":{"$ref":"#/components/schemas/AuthorizationServerOrn"},"_links":{"$ref":"#/components/schemas/AuthorizationServerLinks"}},"required":["orn","name","issuerUrl","_links"]}},"components/schemas/PotentialConnectionList":{"id":"components/schemas/PotentialConnectionList","kind":"json-schema","title":"PotentialConnectionList","data":{"type":"object","properties":{"data":{"description":"Potential connections that can be established","type":"array","items":{"$ref":"#/components/schemas/PotentialConnection"}},"_links":{"type":"object","description":"Links available for the potential connection list","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink"},"next":{"$ref":"#/components/schemas/HrefObjectNextLink"}}}},"required":["data","_links"]}},"components/schemas/PotentialConnectionResourceIndicator":{"id":"components/schemas/PotentialConnectionResourceIndicator","kind":"json-schema","title":"PotentialConnectionResourceIndicator","data":{"format":"uri","description":"Resource indicator used when requesting tokens","type":"string"}},"components/schemas/PotentialConnectionServiceAccount":{"id":"components/schemas/PotentialConnectionServiceAccount","kind":"json-schema","title":"PotentialConnectionServiceAccount","data":{"description":"Service account for a potential connection","type":"object","properties":{"name":{"type":"string","description":"Display name of the service account"},"orn":{"$ref":"#/components/schemas/ServiceAccountOrn"},"_links":{"$ref":"#/components/schemas/ServiceAccountLinks"}},"required":["orn","name","_links"]}},"components/schemas/PotentialConnectionVaultedSecret":{"id":"components/schemas/PotentialConnectionVaultedSecret","kind":"json-schema","title":"PotentialConnectionVaultedSecret","data":{"description":"Vaulted secret for a potential connection","type":"object","properties":{"description":{"type":"string","description":"Optional description of the secret"},"name":{"type":"string","description":"Display name of the secret"},"orn":{"$ref":"#/components/schemas/VaultedSecretOrn"},"path":{"type":"string","description":"Secret path in Okta Privileged Access (OPA)"},"_links":{"$ref":"#/components/schemas/VaultedSecretLinks"}},"required":["orn","name","_links"]}},"components/schemas/PotentialConnectionVirtualMcpServer":{"id":"components/schemas/PotentialConnectionVirtualMcpServer","kind":"json-schema","title":"PotentialConnectionVirtualMcpServer","data":{"description":"Virtual MCP server for a potential connection","type":"object","properties":{"name":{"type":"string","description":"Display name of the virtual MCP server"},"orn":{"$ref":"#/components/schemas/VirtualMcpServerOrn"},"_links":{"$ref":"#/components/schemas/VirtualMcpServerLinks"}},"required":["orn","name","_links"]}},"components/schemas/PotentialIdentityAssertionA2AServerConnection":{"id":"components/schemas/PotentialIdentityAssertionA2AServerConnection","kind":"json-schema","title":"PotentialIdentityAssertionA2AServerConnection","data":{"description":"A potential identity assertion connection for an agent-to-agent (A2A) server that can be established","additionalProperties":false,"type":"object","properties":{"authorizationServer":{"$ref":"#/components/schemas/PotentialConnectionCustomAuthorizationServer"},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_A2A_SERVER"],"description":"Type of connection authentication method"},"resource":{"$ref":"#/components/schemas/PotentialConnectionA2aServer"}},"required":["connectionType","resource","authorizationServer"]}},"components/schemas/PotentialIdentityAssertionAppInstanceConnection":{"id":"components/schemas/PotentialIdentityAssertionAppInstanceConnection","kind":"json-schema","title":"PotentialIdentityAssertionAppInstanceConnection","data":{"description":"A potential identity assertion connection that targets an app instance","additionalProperties":false,"type":"object","properties":{"appInstance":{"$ref":"#/components/schemas/PotentialConnectionAppInstance"},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_APP_INSTANCE"],"description":"Type of connection authentication method"},"resourceIndicator":{"$ref":"#/components/schemas/PotentialConnectionResourceIndicator"}},"required":["connectionType","appInstance"]}},"components/schemas/PotentialIdentityAssertionCustomASConnection":{"id":"components/schemas/PotentialIdentityAssertionCustomASConnection","kind":"json-schema","title":"PotentialIdentityAssertionCustomASConnection","data":{"description":"A potential identity assertion connection for a custom authorization server that can be established","additionalProperties":false,"type":"object","properties":{"authorizationServer":{"$ref":"#/components/schemas/PotentialConnectionCustomAuthorizationServer"},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_CUSTOM_AS"],"description":"Type of connection authentication method"},"resourceIndicator":{"$ref":"#/components/schemas/PotentialConnectionResourceIndicator"}},"required":["connectionType","authorizationServer","resourceIndicator"]}},"components/schemas/PotentialIdentityAssertionVirtualMcpServerConnection":{"id":"components/schemas/PotentialIdentityAssertionVirtualMcpServerConnection","kind":"json-schema","title":"PotentialIdentityAssertionVirtualMcpServerConnection","data":{"description":"A potential identity assertion connection for a virtual MCP server that can be established","additionalProperties":false,"type":"object","properties":{"authorizationServer":{"$ref":"#/components/schemas/PotentialConnectionCustomAuthorizationServer"},"connectionType":{"type":"string","enum":["IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER"],"description":"Type of connection authentication method"},"resource":{"$ref":"#/components/schemas/PotentialConnectionVirtualMcpServer"}},"required":["connectionType","resource","authorizationServer"]}},"components/schemas/PotentialSTSAccessTokenApiServerResourceData":{"id":"components/schemas/PotentialSTSAccessTokenApiServerResourceData","kind":"json-schema","title":"PotentialSTSAccessTokenApiServerResourceData","data":{"description":"Resource data for an STS access token connection to a third-party API server","type":"object","properties":{"apiServerId":{"type":"string","description":"ID of the associated third-party API server"},"clientAuthSettings":{"$ref":"#/components/schemas/ResourceConnectionClientAuthSettings"},"name":{"type":"string","description":"Display name of the third-party API server"},"orn":{"$ref":"#/components/schemas/ApiServerOrn"},"resourceType":{"type":"string","enum":["API_SERVER"],"description":"Type of resource for this STS access token connection"},"resourceUrl":{"type":"string","format":"uri","description":"URL of the third-party API server"},"_links":{"$ref":"#/components/schemas/ApiServerLinks"}},"required":["resourceType","orn","apiServerId","clientAuthSettings","_links"]}},"components/schemas/PotentialSTSAccessTokenAppInstanceResourceData":{"id":"components/schemas/PotentialSTSAccessTokenAppInstanceResourceData","kind":"json-schema","title":"PotentialSTSAccessTokenAppInstanceResourceData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource data for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection to an app instance"},"children":[]}]}]}],"type":"object","properties":{"appInstanceId":{"type":"string","description":"ID of the associated app instance"},"appInstanceName":{"type":"string","description":"Display name of the associated app instance"},"clientAuthSettings":{"$ref":"#/components/schemas/ResourceConnectionClientAuthSettings"},"logo":{"type":"string","description":"Image URL for the app logo"},"orn":{"$ref":"#/components/schemas/AppInstanceOrn"},"resourceType":{"type":"string","enum":["APP_INSTANCE"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of resource for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection"},"children":[]}]}]}]},"_links":{"$ref":"#/components/schemas/AppInstanceLinks"}},"required":["resourceType","orn","appInstanceId","appInstanceName","clientAuthSettings","_links"]}},"components/schemas/PotentialSTSAccessTokenConnection":{"id":"components/schemas/PotentialSTSAccessTokenConnection","kind":"json-schema","title":"PotentialSTSAccessTokenConnection","data":{"description":"A potential STS connection for OAuth-based token exchange (app instances or third-party MCP servers)","additionalProperties":false,"type":"object","properties":{"connectionType":{"type":"string","enum":["STS_ACCESS_TOKEN"],"description":"Type of connection authentication method"},"resource":{"$ref":"#/components/schemas/PotentialSTSAccessTokenResourceData"},"resourceIndicator":{"$ref":"#/components/schemas/PotentialConnectionResourceIndicator"}},"required":["connectionType","resource","resourceIndicator"]}},"components/schemas/PotentialSTSAccessTokenMcpServerResourceData":{"id":"components/schemas/PotentialSTSAccessTokenMcpServerResourceData","kind":"json-schema","title":"PotentialSTSAccessTokenMcpServerResourceData","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource data for an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection to a third-party MCP server"},"children":[]}]}]}],"type":"object","properties":{"clientAuthSettings":{"$ref":"#/components/schemas/ResourceConnectionClientAuthSettings"},"endpointUrl":{"type":"string","description":"Endpoint URL of the third-party MCP server"},"mcpServerId":{"type":"string","description":"ID of the associated third-party MCP server"},"name":{"type":"string","description":"Display name of the third-party MCP server"},"orn":{"$ref":"#/components/schemas/McpServerOrn"},"resourceType":{"type":"string","enum":["MCP_SERVER"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of resource for this "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"STS_ACCESS_TOKEN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection"},"children":[]}]}]}]},"_links":{"$ref":"#/components/schemas/McpServerLinks"}},"required":["resourceType","orn","mcpServerId","clientAuthSettings","_links"]}},"components/schemas/PotentialSTSAccessTokenResourceData":{"id":"components/schemas/PotentialSTSAccessTokenResourceData","kind":"json-schema","title":"PotentialSTSAccessTokenResourceData","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"oneOf":[{"$ref":"#/components/schemas/PotentialSTSAccessTokenAppInstanceResourceData"},{"$ref":"#/components/schemas/PotentialSTSAccessTokenMcpServerResourceData"},{"$ref":"#/components/schemas/PotentialSTSAccessTokenApiServerResourceData"}],"type":"object","discriminator":{"propertyName":"resourceType","mapping":{"APP_INSTANCE":"#/components/schemas/PotentialSTSAccessTokenAppInstanceResourceData","MCP_SERVER":"#/components/schemas/PotentialSTSAccessTokenMcpServerResourceData","API_SERVER":"#/components/schemas/PotentialSTSAccessTokenApiServerResourceData"}}}},"components/schemas/PotentialSTSServiceAccountConnection":{"id":"components/schemas/PotentialSTSServiceAccountConnection","kind":"json-schema","title":"PotentialSTSServiceAccountConnection","data":{"description":"A potential STS connection to a service account that can be established","additionalProperties":false,"type":"object","properties":{"app":{"$ref":"#/components/schemas/PotentialConnectionAppInstance"},"connectionType":{"type":"string","enum":["STS_SERVICE_ACCOUNT"],"description":"Type of connection authentication method"},"resourceIndicator":{"$ref":"#/components/schemas/PotentialConnectionResourceIndicator"},"serviceAccount":{"$ref":"#/components/schemas/PotentialConnectionServiceAccount"}},"required":["connectionType","app","serviceAccount","resourceIndicator"]}},"components/schemas/PotentialSTSVaultSecretConnection":{"id":"components/schemas/PotentialSTSVaultSecretConnection","kind":"json-schema","title":"PotentialSTSVaultSecretConnection","data":{"description":"A potential STS connection to a vaulted secret that can be established","additionalProperties":false,"type":"object","properties":{"connectionType":{"type":"string","enum":["STS_VAULT_SECRET"],"description":"Type of connection authentication method"},"resourceIndicator":{"$ref":"#/components/schemas/PotentialConnectionResourceIndicator"},"secret":{"$ref":"#/components/schemas/PotentialConnectionVaultedSecret"}},"required":["connectionType","secret","resourceIndicator"]}},"components/schemas/ReplaceAIAgentProviderRequest":{"id":"components/schemas/ReplaceAIAgentProviderRequest","kind":"json-schema","title":"ReplaceAIAgentProviderRequest","data":{"description":"The request to replace an AI agent provider","type":"object","properties":{"configuration":{"$ref":"#/components/schemas/Configuration"},"owners":{"$ref":"#/components/schemas/Owners"},"schedule":{"$ref":"#/components/schemas/Schedule"}},"required":["configuration"]}},"components/schemas/ReplaceAIAgentProviderSourcePrioritiesRequest":{"id":"components/schemas/ReplaceAIAgentProviderSourcePrioritiesRequest","kind":"json-schema","title":"ReplaceAIAgentProviderSourcePrioritiesRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The request to replace the full integration source priority order."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The order of the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array defines the new priority order — the first item has the highest priority."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All currently registered source IDs must be included. Omitting any source or including duplicate IDs results in a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error."},"children":[]}]}]}],"type":"object","properties":{"data":{"type":"array","description":"All integration sources in the desired priority order, highest priority first","minItems":1,"items":{"$ref":"#/components/schemas/AIAgentProviderSourcePriorityItem"}}},"required":["data"]}},"components/schemas/ReplaceVirtualMCPConnectionCapabilitiesRequest":{"id":"components/schemas/ReplaceVirtualMCPConnectionCapabilitiesRequest","kind":"json-schema","title":"ReplaceVirtualMCPConnectionCapabilitiesRequest","data":{"description":"Request to replace all capabilities on a virtual MCP connection","type":"object","properties":{"data":{"type":"array","description":"The full set of capabilities to select for this virtual MCP connection. Replaces any existing selections.","minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/ReplaceVirtualMCPConnectionCapabilityItem"}}},"required":["data"]}},"components/schemas/ReplaceVirtualMCPConnectionCapabilityItem":{"id":"components/schemas/ReplaceVirtualMCPConnectionCapabilityItem","kind":"json-schema","title":"ReplaceVirtualMCPConnectionCapabilityItem","data":{"description":"A capability entry in a full-replace request","type":"object","properties":{"alias":{"$ref":"#/components/schemas/VirtualMCPCapabilityAliasPatchable"},"sourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the source capability on the upstream resource server"},"children":[]}]}]}],"example":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k"}},"required":["sourceOrn"]}},"components/schemas/ResourceConnection":{"id":"components/schemas/ResourceConnection","kind":"json-schema","title":"ResourceConnection","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"oneOf":[{"$ref":"#/components/schemas/IdentityAssertionCustomASConnection"},{"$ref":"#/components/schemas/STSVaultSecretConnection"},{"$ref":"#/components/schemas/STSServiceAccountConnection"},{"$ref":"#/components/schemas/STSAccessTokenConnection"},{"$ref":"#/components/schemas/IdentityAssertionA2AServerConnection"},{"$ref":"#/components/schemas/IdentityAssertionAppInstanceConnection"},{"$ref":"#/components/schemas/IdentityAssertionVirtualMcpServerConnection"}],"type":"object","discriminator":{"propertyName":"connectionType","mapping":{"IDENTITY_ASSERTION_CUSTOM_AS":"#/components/schemas/IdentityAssertionCustomASConnection","STS_VAULT_SECRET":"#/components/schemas/STSVaultSecretConnection","STS_SERVICE_ACCOUNT":"#/components/schemas/STSServiceAccountConnection","STS_ACCESS_TOKEN":"#/components/schemas/STSAccessTokenConnection","IDENTITY_ASSERTION_A2A_SERVER":"#/components/schemas/IdentityAssertionA2AServerConnection","IDENTITY_ASSERTION_APP_INSTANCE":"#/components/schemas/IdentityAssertionAppInstanceConnection","IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER":"#/components/schemas/IdentityAssertionVirtualMcpServerConnection"}}}},"components/schemas/ResourceConnectionA2aServer":{"id":"components/schemas/ResourceConnectionA2aServer","kind":"json-schema","title":"ResourceConnectionA2aServer","data":{"description":"Agent-to-agent (A2A) server for the resource connection","type":"object","properties":{"name":{"type":"string","description":"Display name of the agent-to-agent (A2A) server"},"orn":{"$ref":"#/components/schemas/A2aServerOrn"},"_links":{"$ref":"#/components/schemas/A2aServerLinks"}},"required":["orn","name","_links"]}},"components/schemas/ResourceConnectionAppInstance":{"id":"components/schemas/ResourceConnectionAppInstance","kind":"json-schema","title":"ResourceConnectionAppInstance","data":{"description":"App instance for the resource connection","type":"object","properties":{"logo":{"type":"string","description":"Image URL for the app logo"},"name":{"type":"string","description":"Display name of the app"},"orn":{"$ref":"#/components/schemas/AppInstanceOrn"},"_links":{"$ref":"#/components/schemas/AppInstanceLinks"}},"required":["orn","name","_links"]}},"components/schemas/ResourceConnectionClientAuthSettings":{"id":"components/schemas/ResourceConnectionClientAuthSettings","kind":"json-schema","title":"ResourceConnectionClientAuthSettings","data":{"description":"Client authentication settings backing the resource connection","type":"object","properties":{"name":{"type":"string","description":"Display name of the client authentication settings"},"oauthConfiguration":{"$ref":"#/components/schemas/ResourceConnectionClientAuthSettingsOauthConfiguration"},"orn":{"$ref":"#/components/schemas/ClientAuthSettingsOrn"},"_links":{"$ref":"#/components/schemas/ClientAuthSettingsLinks"}},"required":["orn","_links"]}},"components/schemas/ResourceConnectionClientAuthSettingsOauthConfiguration":{"id":"components/schemas/ResourceConnectionClientAuthSettingsOauthConfiguration","kind":"json-schema","title":"ResourceConnectionClientAuthSettingsOauthConfiguration","data":{"description":"OAuth protocol configuration for the resource connection client authentication settings","type":"object","properties":{"scopes":{"type":"array","items":{"type":"string"},"description":"OAuth scopes configured for this client authentication setting","example":["tools:read","tools:execute"]}}}},"components/schemas/ResourceConnectionCreatable":{"id":"components/schemas/ResourceConnectionCreatable","kind":"json-schema","title":"ResourceConnectionCreatable","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"description":"Create a new connection","oneOf":[{"$ref":"#/components/schemas/IdentityAssertionCustomASConnectionCreatable"},{"$ref":"#/components/schemas/STSVaultSecretConnectionCreatable"},{"$ref":"#/components/schemas/STSServiceAccountConnectionCreatable"},{"$ref":"#/components/schemas/STSAccessTokenConnectionCreatable"},{"$ref":"#/components/schemas/IdentityAssertionA2AServerConnectionCreatable"},{"$ref":"#/components/schemas/IdentityAssertionAppInstanceConnectionCreatable"},{"$ref":"#/components/schemas/IdentityAssertionVirtualMcpServerConnectionCreatable"}],"type":"object","discriminator":{"propertyName":"connectionType","mapping":{"IDENTITY_ASSERTION_CUSTOM_AS":"#/components/schemas/IdentityAssertionCustomASConnectionCreatable","STS_VAULT_SECRET":"#/components/schemas/STSVaultSecretConnectionCreatable","STS_SERVICE_ACCOUNT":"#/components/schemas/STSServiceAccountConnectionCreatable","STS_ACCESS_TOKEN":"#/components/schemas/STSAccessTokenConnectionCreatable","IDENTITY_ASSERTION_A2A_SERVER":"#/components/schemas/IdentityAssertionA2AServerConnectionCreatable","IDENTITY_ASSERTION_APP_INSTANCE":"#/components/schemas/IdentityAssertionAppInstanceConnectionCreatable","IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER":"#/components/schemas/IdentityAssertionVirtualMcpServerConnectionCreatable"}}}},"components/schemas/ResourceConnectionCustomAuthorizationServer":{"id":"components/schemas/ResourceConnectionCustomAuthorizationServer","kind":"json-schema","title":"ResourceConnectionCustomAuthorizationServer","data":{"description":"Custom authorization server for the resource connection","type":"object","properties":{"issuerUrl":{"type":"string","description":"Issuer URL for the authorization server"},"logo":{"type":"string","description":"Image URL for the authorization server"},"name":{"type":"string","description":"Display name of the authorization server"},"orn":{"$ref":"#/components/schemas/AuthorizationServerOrn"},"_links":{"$ref":"#/components/schemas/AuthorizationServerLinks"}},"required":["orn","name","issuerUrl","_links"]}},"components/schemas/ResourceConnectionId":{"id":"components/schemas/ResourceConnectionId","kind":"json-schema","title":"ResourceConnectionId","data":{"description":"Unique identifier for the resource connection. Only present for resource connections.","type":"string"}},"components/schemas/ResourceConnectionLinks":{"id":"components/schemas/ResourceConnectionLinks","kind":"json-schema","title":"ResourceConnectionLinks","data":{"description":"Specifies link relations available for the resource connection","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the resource connection instance via the Okta API"}},"required":["self"]}},"components/schemas/ResourceConnectionList":{"id":"components/schemas/ResourceConnectionList","kind":"json-schema","title":"ResourceConnectionList","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"type":"object","properties":{"data":{"description":"All connections the AI agent has established","type":"array","items":{"$ref":"#/components/schemas/ResourceConnection"}},"_links":{"type":"object","description":"Links available in managed list response","required":["self"],"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}},"required":["data","_links"]}},"components/schemas/ResourceConnectionOrn":{"id":"components/schemas/ResourceConnectionOrn","kind":"json-schema","title":"ResourceConnectionOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the resource connection"},"children":[]}]}]}],"type":"string"}},"components/schemas/ResourceConnectionPatchable":{"id":"components/schemas/ResourceConnectionPatchable","kind":"json-schema","title":"ResourceConnectionPatchable","data":{"description":"Update an existing resource connection. All fields are optional for partial updates.","type":"object","properties":{"issuerUrl":{"$ref":"#/components/schemas/ResourceConnectionPatchableIssuerUrl"},"resourceIndicator":{"$ref":"#/components/schemas/ResourceConnectionPatchableResourceIndicator"},"scopeCondition":{"$ref":"#/components/schemas/ResourceConnectionPatchableScopeCondition"},"scopes":{"$ref":"#/components/schemas/ResourceConnectionPatchableScopes"}}}},"components/schemas/ResourceConnectionPatchableIssuerUrl":{"id":"components/schemas/ResourceConnectionPatchableIssuerUrl","kind":"json-schema","title":"ResourceConnectionPatchableIssuerUrl","data":{"format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The issuer URL of the authorization server for the connection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for identity assertion connection types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a 400 error if sent for STS connection types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be a valid URI"},"children":[]}]}]}]}],"type":"string"}},"components/schemas/ResourceConnectionPatchableResourceIndicator":{"id":"components/schemas/ResourceConnectionPatchableResourceIndicator","kind":"json-schema","title":"ResourceConnectionPatchableResourceIndicator","data":{"format":"uri","nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource indicator used when requesting tokens. Set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"null"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to reset to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN)."},"children":[]}]}]}],"type":"string"}},"components/schemas/ResourceConnectionPatchableScopeCondition":{"id":"components/schemas/ResourceConnectionPatchableScopeCondition","kind":"json-schema","title":"ResourceConnectionPatchableScopeCondition","data":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Determines how Okta evaluates requested scopes for the connection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_CUSTOM_AS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_A2A_SERVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be provided together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopes"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a 400 error if sent for STS connection types"},"children":[]}]}]}]}],"type":"string","enum":["ALL_SCOPES","EXCLUDE","INCLUDE_ONLY"]}},"components/schemas/ResourceConnectionPatchableScopes":{"id":"components/schemas/ResourceConnectionPatchableScopes","kind":"json-schema","title":"ResourceConnectionPatchableScopes","data":{"nullable":true,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Array of scopes for the connection. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ALL_SCOPES"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", this array must contain a single value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"INCLUDE_ONLY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the specified scopes are allowed. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"EXCLUDE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all scopes except the specified are allowed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrictions:"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Valid for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_CUSTOM_AS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IDENTITY_ASSERTION_A2A_SERVER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" connection types"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Must be provided together with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopeCondition"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns a 400 error if sent for STS connection types"},"children":[]}]}]}]}],"minItems":1,"items":{"type":"string"},"type":"array"}},"components/schemas/ResourceConnectionResourceIndicator":{"id":"components/schemas/ResourceConnectionResourceIndicator","kind":"json-schema","title":"ResourceConnectionResourceIndicator","data":{"format":"uri","description":"Resource indicator used when requesting tokens","type":"string"}},"components/schemas/ResourceConnectionServiceAccount":{"id":"components/schemas/ResourceConnectionServiceAccount","kind":"json-schema","title":"ResourceConnectionServiceAccount","data":{"description":"Service account for the resource connection","type":"object","properties":{"name":{"type":"string","description":"Display name of the service account"},"orn":{"$ref":"#/components/schemas/ServiceAccountOrn"},"_links":{"$ref":"#/components/schemas/ServiceAccountLinks"}},"required":["orn","name","_links"]}},"components/schemas/ResourceConnectionStatus":{"id":"components/schemas/ResourceConnectionStatus","kind":"json-schema","title":"ResourceConnectionStatus","data":{"description":"The status of the connection","type":"string","enum":["ACTIVE","INACTIVE"],"x-enumDescriptions":{"ACTIVE":"The agent connection is active","INACTIVE":"The agent connection is inactive"}}},"components/schemas/ResourceConnectionVaultedSecret":{"id":"components/schemas/ResourceConnectionVaultedSecret","kind":"json-schema","title":"ResourceConnectionVaultedSecret","data":{"description":"Secret for the resource connection","type":"object","properties":{"description":{"type":"string","description":"Optional description of the secret"},"name":{"type":"string","description":"Display name of the secret"},"orn":{"$ref":"#/components/schemas/VaultedSecretOrn"},"path":{"type":"string","description":"Secret path in Okta Privileged Access (OPA)"},"_links":{"$ref":"#/components/schemas/VaultedSecretLinks"}},"required":["orn","name","_links"]}},"components/schemas/ResourceConnectionVirtualMcpServer":{"id":"components/schemas/ResourceConnectionVirtualMcpServer","kind":"json-schema","title":"ResourceConnectionVirtualMcpServer","data":{"description":"Virtual MCP server for the resource connection","type":"object","properties":{"name":{"type":"string","description":"Display name of the virtual MCP server"},"orn":{"$ref":"#/components/schemas/VirtualMcpServerOrn"},"_links":{"$ref":"#/components/schemas/VirtualMcpServerLinks"}},"required":["orn","name","_links"]}},"components/schemas/STSAccessTokenConnection":{"id":"components/schemas/STSAccessTokenConnection","kind":"json-schema","title":"STSAccessTokenConnection","data":{"description":"STS connection for OAuth-based token exchange (app instances or third-party MCP servers)","additionalProperties":false,"type":"object","properties":{"connectionType":{"type":"string","enum":["STS_ACCESS_TOKEN"],"description":"Type of connection authentication method"},"id":{"$ref":"#/components/schemas/ResourceConnectionId"},"orn":{"$ref":"#/components/schemas/ResourceConnectionOrn"},"resource":{"$ref":"#/components/schemas/ManagedSTSAccessTokenResourceData"},"resourceIndicator":{"$ref":"#/components/schemas/ResourceConnectionResourceIndicator"},"status":{"$ref":"#/components/schemas/ResourceConnectionStatus"},"_links":{"$ref":"#/components/schemas/ResourceConnectionLinks"}},"required":["connectionType","resource","resourceIndicator","id","orn","status","_links"]}},"components/schemas/STSAccessTokenConnectionCreatable":{"id":"components/schemas/STSAccessTokenConnectionCreatable","kind":"json-schema","title":"STSAccessTokenConnectionCreatable","data":{"description":"Create an STS connection for OAuth-based token exchange (app instances or third-party MCP servers)","type":"object","properties":{"connectionType":{"type":"string","enum":["STS_ACCESS_TOKEN"],"description":"Type of connection authentication method"},"resource":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ResourceServersClientAuthSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/ClientAuthSettingsOrn"}}},"resourceIndicator":{"type":"string","format":"uri","description":"Optional custom resource indicator. Defaults to the resource ORN if not specified."}},"required":["connectionType","resource"]}},"components/schemas/STSServiceAccountConnection":{"id":"components/schemas/STSServiceAccountConnection","kind":"json-schema","title":"STSServiceAccountConnection","data":{"description":"STS connection to a service account","additionalProperties":false,"type":"object","properties":{"app":{"$ref":"#/components/schemas/ResourceConnectionAppInstance"},"connectionType":{"type":"string","enum":["STS_SERVICE_ACCOUNT"],"description":"Type of connection authentication method"},"id":{"$ref":"#/components/schemas/ResourceConnectionId"},"orn":{"$ref":"#/components/schemas/ResourceConnectionOrn"},"resourceIndicator":{"$ref":"#/components/schemas/ResourceConnectionResourceIndicator"},"serviceAccount":{"$ref":"#/components/schemas/ResourceConnectionServiceAccount"},"status":{"$ref":"#/components/schemas/ResourceConnectionStatus"},"_links":{"$ref":"#/components/schemas/ResourceConnectionLinks"}},"required":["connectionType","app","serviceAccount","resourceIndicator","id","orn","status","_links"]}},"components/schemas/STSServiceAccountConnectionCreatable":{"id":"components/schemas/STSServiceAccountConnectionCreatable","kind":"json-schema","title":"STSServiceAccountConnectionCreatable","data":{"description":"Create an STS connection for a service account","type":"object","properties":{"app":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to an app instance in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/AppInstanceOrn"}}},"connectionType":{"type":"string","enum":["STS_SERVICE_ACCOUNT"],"description":"Type of connection authentication method"},"resourceIndicator":{"type":"string","format":"uri","description":"Resource indicator used when requesting tokens. Defaults to the service account's ORN if not specified."},"serviceAccount":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to a service account in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/ServiceAccountOrn"}}}},"required":["connectionType","app","serviceAccount"]}},"components/schemas/STSVaultSecretConnection":{"id":"components/schemas/STSVaultSecretConnection","kind":"json-schema","title":"STSVaultSecretConnection","data":{"description":"STS connection to a vaulted secret","additionalProperties":false,"type":"object","properties":{"connectionType":{"type":"string","enum":["STS_VAULT_SECRET"],"description":"Type of connection authentication method"},"id":{"$ref":"#/components/schemas/ResourceConnectionId"},"orn":{"$ref":"#/components/schemas/ResourceConnectionOrn"},"resourceIndicator":{"$ref":"#/components/schemas/ResourceConnectionResourceIndicator"},"secret":{"$ref":"#/components/schemas/ResourceConnectionVaultedSecret"},"status":{"$ref":"#/components/schemas/ResourceConnectionStatus"},"_links":{"$ref":"#/components/schemas/ResourceConnectionLinks"}},"required":["connectionType","secret","resourceIndicator","id","orn","status","_links"]}},"components/schemas/STSVaultSecretConnectionCreatable":{"id":"components/schemas/STSVaultSecretConnectionCreatable","kind":"json-schema","title":"STSVaultSecretConnectionCreatable","data":{"description":"Create an STS connection for a vaulted secret","type":"object","properties":{"connectionType":{"type":"string","enum":["STS_VAULT_SECRET"],"description":"Type of connection authentication method"},"resourceIndicator":{"type":"string","format":"uri","description":"Resource indicator used when requesting tokens. Defaults to the vaulted secret's ORN if not specified."},"secret":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reference to a vaulted secret in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" format"},"children":[]}]}]}],"required":["orn"],"properties":{"orn":{"$ref":"#/components/schemas/VaultedSecretOrn"}}}},"required":["connectionType","secret"]}},"components/schemas/SamlApplicationDelegationLinkFrom":{"id":"components/schemas/SamlApplicationDelegationLinkFrom","kind":"json-schema","title":"SamlApplicationDelegationLinkFrom","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A token source that is a SAML 2.0 app. The delegation link accepts SAML assertions issued for the referenced app as subject tokens in the SAML to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" step of Cross-App Access."},"children":[]}]}]}],"additionalProperties":false,"type":"object","properties":{"appInstanceOrn":{"$ref":"#/components/schemas/AppInstanceOrn"},"tokenType":{"$ref":"#/components/schemas/DelegationLinkTokenType"},"type":{"type":"string","description":"The type of token source","enum":["SAML_APPLICATION"]}},"required":["type","appInstanceOrn","tokenType"]}},"components/schemas/SamlApplicationDelegationLinkFromCreatable":{"id":"components/schemas/SamlApplicationDelegationLinkFromCreatable","kind":"json-schema","title":"SamlApplicationDelegationLinkFromCreatable","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a delegation link. It accepts SAML 2.0 assertions issued for the referenced SAML app as subject tokens in the SAML to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"refresh_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" step of Cross-App Access."},"children":[]}]}]}],"additionalProperties":false,"type":"object","properties":{"appInstanceOrn":{"$ref":"#/components/schemas/AppInstanceOrn"},"tokenType":{"$ref":"#/components/schemas/DelegationLinkTokenType"},"type":{"type":"string","description":"The type of token source","enum":["SAML_APPLICATION"]}},"required":["type","appInstanceOrn","tokenType"]}},"components/schemas/Schedule":{"id":"components/schemas/Schedule","kind":"json-schema","title":"Schedule","data":{"type":"object","properties":{"cron":{"type":"string","description":"The schedule of the import in cron format. The frequency must be greater than or equal to 1 hour between imports. Only hourly and weekly cadences are allowed.","example":"0 0 * * * ?"},"timezone":{"type":"string","description":"Timezone of where the scheduled import takes place","example":"America/New_York"}},"required":["cron","timezone"]}},"components/schemas/ScopeCondition":{"id":"components/schemas/ScopeCondition","kind":"json-schema","title":"ScopeCondition","data":{"description":"Determines how Okta evaluates requested scopes for the connection","type":"string","enum":["ALL_SCOPES","EXCLUDE","INCLUDE_ONLY"],"x-enumDescriptions":{"ALL_SCOPES":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All scopes are evaluated as part of the connection. For this condition, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array must contain a single value of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate all scopes."},"children":[]}]}]}],"INCLUDE_ONLY":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the scopes specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are evaluated as part of the connection"},"children":[]}]}]}],"EXCLUDE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All scopes except those specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scopes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are evaluated as part of the connection"},"children":[]}]}]}]}}},"components/schemas/ServiceAccountLinks":{"id":"components/schemas/ServiceAccountLinks","kind":"json-schema","title":"ServiceAccountLinks","data":{"description":"Specifies link relations available for the service account","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the service account through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the service account in the Admin Console"}},"required":["self"]}},"components/schemas/ServiceAccountOrn":{"id":"components/schemas/ServiceAccountOrn","kind":"json-schema","title":"ServiceAccountOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the service account"},"children":[]}]}]}],"type":"string"}},"components/schemas/UpdateAIAgentProviderRequest":{"id":"components/schemas/UpdateAIAgentProviderRequest","kind":"json-schema","title":"UpdateAIAgentProviderRequest","data":{"description":"The request to update an AI agent provider","type":"object","properties":{"configuration":{"type":"object","nullable":true,"additionalProperties":true},"owners":{"type":"object","nullable":true,"properties":{"userOrns":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List of resource-owner user "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORNs"},"children":[]}]}]}]}],"minItems":1,"maxItems":5,"items":{"type":"string"}},"groupOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource-owner group "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]}]}]}]}}},"schedule":{"type":"object","nullable":true,"required":["cron","timezone"],"properties":{"cron":{"type":"string","description":"The schedule of the import in cron format. The frequency must be greater than or equal to 1 hour between imports. Only hourly and weekly cadences are allowed.","example":"0 0 * * * ?"},"timezone":{"type":"string","description":"Timezone of where the scheduled import takes place","example":"America/New_York"}}}}}},"components/schemas/UpdateAIAgentRequest":{"id":"components/schemas/UpdateAIAgentRequest","kind":"json-schema","title":"UpdateAIAgentRequest","data":{"type":"object","properties":{"appId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ID of the connected app for the AI agent. Deprecated. Use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/secures-ai/openapi/secures-ai-workload-principals/tags/delegationlinks"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Delegation Links API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" instead."},"children":[]}]}]}],"readOnly":false,"deprecated":true},"profile":{"$ref":"#/components/schemas/AIAgentProfile"}},"required":["profile"]}},"components/schemas/UpdateVirtualMCPConnectionCapabilityRequest":{"id":"components/schemas/UpdateVirtualMCPConnectionCapabilityRequest","kind":"json-schema","title":"UpdateVirtualMCPConnectionCapabilityRequest","data":{"description":"Request to update a specific capability on a virtual MCP connection","type":"object","properties":{"alias":{"$ref":"#/components/schemas/VirtualMCPCapabilityAliasPatchable"}}}},"components/schemas/ValidateAIAgentProviderRequest":{"id":"components/schemas/ValidateAIAgentProviderRequest","kind":"json-schema","title":"ValidateAIAgentProviderRequest","data":{"description":"The request to validate an AI agent provider","type":"object","properties":{"configuration":{"$ref":"#/components/schemas/Configuration"},"sourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the source"},"children":[]}]}]}]}},"required":["sourceOrn","configuration"]}},"components/schemas/VaultedSecretLinks":{"id":"components/schemas/VaultedSecretLinks","kind":"json-schema","title":"VaultedSecretLinks","data":{"description":"Specifies link relations available for the vaulted secret","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the vaulted secret through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the vaulted secret in the Admin Console"}},"required":["self"]}},"components/schemas/VaultedSecretOrn":{"id":"components/schemas/VaultedSecretOrn","kind":"json-schema","title":"VaultedSecretOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the vaulted secret"},"children":[]}]}]}],"type":"string"}},"components/schemas/VirtualMCP":{"id":"components/schemas/VirtualMCP","kind":"json-schema","title":"VirtualMCP","data":{"allOf":[{"$ref":"#/components/schemas/VirtualMCPBase"},{"type":"object","properties":{"_links":{"$ref":"#/components/schemas/VirtualMCPLinks"}},"required":["_links"]}]}},"components/schemas/VirtualMCPBase":{"id":"components/schemas/VirtualMCPBase","kind":"json-schema","title":"VirtualMCPBase","data":{"description":"Base properties of the virtual MCP resource","type":"object","properties":{"created":{"type":"string","format":"date-time","description":"Timestamp when the virtual MCP was created","readOnly":true,"example":"2025-06-01T10:00:00Z"},"id":{"type":"string","description":"Unique identifier for the virtual MCP","readOnly":true,"example":"wlp1aB2cD3eF4gH5iJ6k"},"lastUpdated":{"type":"string","format":"date-time","description":"Timestamp when the virtual MCP was last updated","readOnly":true,"example":"2025-06-15T14:30:00Z"},"orn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the virtual MCP"},"children":[]}]}]}],"readOnly":true,"example":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k"},"profile":{"$ref":"#/components/schemas/VirtualMCPProfile"},"status":{"type":"string","description":"Current status of the virtual MCP in its lifecycle","enum":["INACTIVE","ACTIVE"],"x-enumDescriptions":{"INACTIVE":"Virtual MCP is inactive","ACTIVE":"Virtual MCP is active and operational"},"example":"ACTIVE"}},"required":["id","orn","status","profile","created","lastUpdated"]}},"components/schemas/VirtualMCPCapability":{"id":"components/schemas/VirtualMCPCapability","kind":"json-schema","title":"VirtualMCPCapability","data":{"description":"A capability selected for a virtual MCP server","allOf":[{"$ref":"#/components/schemas/VirtualMCPCapabilityBase"},{"type":"object","properties":{"type":{"type":"string","description":"The type of the capability","example":"TOOL"}},"required":["type"]}]}},"components/schemas/VirtualMCPCapabilityAlias":{"id":"components/schemas/VirtualMCPCapabilityAlias","kind":"json-schema","title":"VirtualMCPCapabilityAlias","data":{"description":"Admin-defined alias that overrides the capability's default name when exposed through the virtual MCP server","minLength":1,"maxLength":255,"example":"get_jira_issues","type":"string"}},"components/schemas/VirtualMCPCapabilityAliasPatchable":{"id":"components/schemas/VirtualMCPCapabilityAliasPatchable","kind":"json-schema","title":"VirtualMCPCapabilityAliasPatchable","data":{"nullable":true,"description":"Admin-defined alias that overrides the capability's default name when exposed through the virtual MCP server. If not provided, defaults to the capability name as reported by the upstream resource server.","minLength":1,"maxLength":255,"example":"get_jira_issues","type":"string"}},"components/schemas/VirtualMCPCapabilityBase":{"id":"components/schemas/VirtualMCPCapabilityBase","kind":"json-schema","title":"VirtualMCPCapabilityBase","data":{"description":"Shared properties for all capability types","type":"object","properties":{"connectionOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the connection that provides authentication data for the resource server this capability is bound to"},"children":[]}]}]}],"example":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the capability. Use this value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{capabilityId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}],"readOnly":true,"example":"vsc1aB2cD3eF4gH5iJ6k"},"profile":{"$ref":"#/components/schemas/VirtualMCPCapabilityProfile"},"sourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the source capability on the upstream resource server"},"children":[]}]}]}],"example":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k"},"status":{"type":"string","description":"Validity status of the capability relative to the upstream MCP server","readOnly":true,"enum":["VALID","INVALID"],"x-enumDescriptions":{"VALID":"The capability still exists on the upstream MCP server","INVALID":"The upstream MCP server no longer reports this capability after its most recent discovery"},"example":"VALID"},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources. Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?expand=inputSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}],"properties":{"inputSchema":{"type":"object","description":"The JSON Schema describing the capability's input parameters","additionalProperties":true}}}},"required":["id","sourceOrn","connectionOrn","status"]}},"components/schemas/VirtualMCPCapabilityProfile":{"id":"components/schemas/VirtualMCPCapabilityProfile","kind":"json-schema","title":"VirtualMCPCapabilityProfile","data":{"description":"Profile for a capability on the virtual MCP","type":"object","properties":{"alias":{"$ref":"#/components/schemas/VirtualMCPCapabilityAlias"},"description":{"type":"string","description":"The description of the capability as reported by the upstream MCP server","example":"Get issues from a repository"},"name":{"type":"string","description":"The name of the capability as reported by the upstream MCP server","example":"get_issues"}},"required":["alias"]}},"components/schemas/VirtualMCPConnectionHrefObjectParentLink":{"id":"components/schemas/VirtualMCPConnectionHrefObjectParentLink","kind":"json-schema","title":"VirtualMCPConnectionHrefObjectParentLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the parent virtual MCP connection"}]}},"components/schemas/VirtualMCPConnectionList":{"id":"components/schemas/VirtualMCPConnectionList","kind":"json-schema","title":"VirtualMCPConnectionList","data":{"type":"object","properties":{"data":{"description":"All connections the virtual MCP has established","type":"array","items":{"$ref":"#/components/schemas/STSAccessTokenConnection"}},"_links":{"description":"Links available in the connection list response","allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}},"required":["data","_links"]}},"components/schemas/VirtualMCPConnectionPatchable":{"id":"components/schemas/VirtualMCPConnectionPatchable","kind":"json-schema","title":"VirtualMCPConnectionPatchable","data":{"description":"Update an existing virtual MCP connection. All fields are optional for partial updates.","type":"object","properties":{"resourceIndicator":{"$ref":"#/components/schemas/ResourceConnectionPatchableResourceIndicator"}}}},"components/schemas/VirtualMCPDescription":{"id":"components/schemas/VirtualMCPDescription","kind":"json-schema","title":"VirtualMCPDescription","data":{"description":"Description of the virtual MCP","minLength":1,"maxLength":2000,"example":"Groups all production MCP servers for the engineering team","type":"string"}},"components/schemas/VirtualMCPDisplayName":{"id":"components/schemas/VirtualMCPDisplayName","kind":"json-schema","title":"VirtualMCPDisplayName","data":{"description":"Human-readable display name for the virtual MCP","minLength":1,"maxLength":255,"example":"Production MCP Servers","type":"string"}},"components/schemas/VirtualMCPHrefObjectResourceServerLink":{"id":"components/schemas/VirtualMCPHrefObjectResourceServerLink","kind":"json-schema","title":"VirtualMCPHrefObjectResourceServerLink","data":{"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/HrefObject"},{"description":"Link to the virtual MCP in the resource server domain"}]}},"components/schemas/VirtualMCPLinks":{"id":"components/schemas/VirtualMCPLinks","kind":"json-schema","title":"VirtualMCPLinks","data":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"type":"object","properties":{"resource-server":{"$ref":"#/components/schemas/VirtualMCPHrefObjectResourceServerLink"}}}]}},"components/schemas/VirtualMCPProfile":{"id":"components/schemas/VirtualMCPProfile","kind":"json-schema","title":"VirtualMCPProfile","data":{"description":"Profile for the virtual MCP, which can be edited by the admin","type":"object","properties":{"description":{"$ref":"#/components/schemas/VirtualMCPDescription"},"displayName":{"$ref":"#/components/schemas/VirtualMCPDisplayName"}}}},"components/schemas/VirtualMCPSelectedTool":{"id":"components/schemas/VirtualMCPSelectedTool","kind":"json-schema","title":"VirtualMCPSelectedTool","data":{"description":"Shared properties for all capability types","type":"object","properties":{"connectionOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the connection that provides authentication data for the resource server this capability is bound to"},"children":[]}]}]}],"example":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k"},"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Unique identifier for the capability. Use this value in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{capabilityId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path parameter."},"children":[]}]}]}],"readOnly":true,"example":"vsc1aB2cD3eF4gH5iJ6k"},"profile":{"$ref":"#/components/schemas/VirtualMCPCapabilityProfile"},"sourceOrn":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the source capability on the upstream resource server"},"children":[]}]}]}],"example":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k"},"status":{"type":"string","description":"Validity status of the capability relative to the upstream MCP server","readOnly":true,"enum":["VALID","INVALID"],"x-enumDescriptions":{"VALID":"The capability still exists on the upstream MCP server","INVALID":"The upstream MCP server no longer reports this capability after its most recent discovery"},"example":"VALID"},"_embedded":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Embedded resources. Only included when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?expand=inputSchema"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified."},"children":[]}]}]}],"properties":{"inputSchema":{"type":"object","description":"The JSON Schema describing the capability's input parameters","additionalProperties":true}}}},"required":["id","sourceOrn","connectionOrn","status"]}},"components/schemas/VirtualMcpServerLinks":{"id":"components/schemas/VirtualMcpServerLinks","kind":"json-schema","title":"VirtualMcpServerLinks","data":{"description":"Specifies link relations available for the virtual MCP server","type":"object","properties":{"self":{"$ref":"#/components/schemas/HrefObjectSelfLink","description":"Link to the virtual MCP server through the Okta API"},"web":{"$ref":"#/components/schemas/HrefObjectWebLink","description":"Link to the virtual MCP server in the Admin Console"}},"required":["self"]}},"components/schemas/VirtualMcpServerOrn":{"id":"components/schemas/VirtualMcpServerOrn","kind":"json-schema","title":"VirtualMcpServerOrn","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#okta-resource-name-orn"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORN"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the virtual MCP server"},"children":[]}]}]}],"type":"string"}},"components/schemas/VirtualMcpSettings":{"id":"components/schemas/VirtualMcpSettings","kind":"json-schema","title":"VirtualMcpSettings","data":{"type":"object","properties":{"basePath":{"type":"string","format":"uri","description":"Default base path for virtual MCP server."},"features":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enabled feature indicators for this domain. Values might be added or removed without notice. Clients "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"must not"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" build business logic that depends on the presence of specific values."},"children":[]}]}]}],"items":{"type":"string"}},"limits":{"type":"object","description":"Org-level limits for virtual MCPs","properties":{"maxVirtualMCPs":{"type":"integer","description":"Maximum number of virtual MCPs allowed for this org"},"maxCapabilitiesPerVirtualMCP":{"type":"integer","description":"Maximum number of capabilities per virtual MCP"},"maxResourceServersPerVirtualMCP":{"type":"integer","description":"Maximum number of resource servers per virtual MCP"}}},"supportedConnectionTypes":{"type":"array","items":{"type":"string"}}}}},"components/schemas/WorkloadPrincipalOAuthClient":{"id":"components/schemas/WorkloadPrincipalOAuthClient","kind":"json-schema","title":"WorkloadPrincipalOAuthClient","data":{"description":"The workload principal's OAuth client identity.","type":"object","properties":{"clientId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The workload principal's OAuth "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"readOnly":true,"example":"wlpx9jQ16k9V8IFEL0g3"}},"required":["clientId"]}},"components/schemas/WorkloadPrincipalOAuthClientCimdRequest":{"id":"components/schemas/WorkloadPrincipalOAuthClientCimdRequest","kind":"json-schema","title":"WorkloadPrincipalOAuthClientCimdRequest","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Registers the AI agent as a CIMD OAuth client, using a hosted metadata URL as the"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"client identity. When provided, Okta creates a CIMD client entity and binding instead"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"of a standard public-client app. Mutually exclusive with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"signOnProvider"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"object","properties":{"clientIdMatchPattern":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The HTTPS URL of the agent's Client ID Metadata Document (CIMD). This URL is used"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"as the agent's OAuth "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"client_id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at the token endpoint and is returned in"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"oauthClient.clientId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on subsequent GET requests."},"children":[]}]}]}],"example":"https://agent.example.com/metadata.json"},"type":{"type":"string","enum":["CIMD"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OAuth client type. Must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CIMD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for CIMD-based agent registration."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This field is immutable after creation."},"children":[]}]}]}],"example":"CIMD"}},"required":["type","clientIdMatchPattern"]}},"components/schemas/WorkloadPrincipalOperationListResponse":{"id":"components/schemas/WorkloadPrincipalOperationListResponse","kind":"json-schema","title":"WorkloadPrincipalOperationListResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/WorkloadPrincipalOperationResponse"}},"_links":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}}}},"components/schemas/WorkloadPrincipalOperationMetadata":{"id":"components/schemas/WorkloadPrincipalOperationMetadata","kind":"json-schema","title":"WorkloadPrincipalOperationMetadata","data":{"description":"Flexible metadata for the workload principal operation","additionalProperties":true,"type":"object"}},"components/schemas/WorkloadPrincipalOperationResponse":{"id":"components/schemas/WorkloadPrincipalOperationResponse","kind":"json-schema","title":"WorkloadPrincipalOperationResponse","data":{"type":"object","properties":{"completed":{"type":"string","description":"Timestamp of when the operation completed","format":"date-time"},"created":{"type":"string","description":"Timestamp of when the operation was created","format":"date-time"},"errorDetails":{"$ref":"#/components/schemas/ErrorDetails"},"id":{"type":"string","description":"ID of the workload principal operation"},"resource":{"$ref":"#/components/schemas/WorkloadPrincipalResource"},"started":{"type":"string","description":"Timestamp of when the operation started","format":"date-time"},"status":{"type":"string","description":"The status of the workload principal operation","enum":["COMPLETED","SCHEDULED","IN_PROGRESS","FAILED"]},"type":{"type":"string","description":"The workload principal operation type","enum":["ai-agent:Register","ai-agent:Replace","ai-agent:Delete","ai-agent:Activate","ai-agent:Deactivate","ai-agent:Patch","ai-agent:Import","virtual-mcp:Register","virtual-mcp:Delete","virtual-mcp:Activate","virtual-mcp:Deactivate","virtual-mcp:ReplaceCapabilities"],"x-enumDescriptions":{"ai-agent:Register":"Operation that registers a new AI agent","ai-agent:Replace":"Operation that replaces an existing AI agent configuration","ai-agent:Delete":"Operation that deletes an AI agent and its associated data","ai-agent:Activate":"Operation that activates an AI agent","ai-agent:Deactivate":"Operation that deactivates an active AI agent","ai-agent:Patch":"Operation that updates specific properties of an AI agent","ai-agent:Import":"Operation that imports AI agents from an external source","virtual-mcp:Register":"Operation that registers a new virtual MCP","virtual-mcp:Delete":"Operation that deletes a virtual MCP","virtual-mcp:Activate":"Operation that activates a virtual MCP","virtual-mcp:Deactivate":"Operation that deactivates a virtual MCP","virtual-mcp:ReplaceCapabilities":"Operation that replaces the capabilities of a virtual MCP connection"}},"operationMetadata":{"$ref":"#/components/schemas/WorkloadPrincipalOperationMetadata"}},"required":["id","type","status","created"]}},"components/schemas/WorkloadPrincipalResource":{"id":"components/schemas/WorkloadPrincipalResource","kind":"json-schema","title":"WorkloadPrincipalResource","data":{"description":"The workload principal resource associated with the operation. These properties are available after the operation completes successfully.","type":"object","properties":{"id":{"type":"string","description":"The ID of the workload principal resource"},"status":{"type":"string","description":"The status of the workload principal resource"},"type":{"type":"string","description":"The type of resource","enum":["ai_agent","virtual_mcp"]},"_links":{"$ref":"#/components/schemas/LinksSelf"}},"required":["id","type","status","_links"]}},"components/schemas/WorkloadPrincipalSignOnProvider":{"id":"components/schemas/WorkloadPrincipalSignOnProvider","kind":"json-schema","title":"WorkloadPrincipalSignOnProvider","data":{"description":"The sign-on provider bound to the workload principal.","type":"object","properties":{"appInstanceId":{"type":"string","description":"ID of the app instance bound to the workload principal.","readOnly":true,"example":"0oaNewApp4561a2b3c4d"}},"required":["appInstanceId"]}},"components/schemas/WorkloadPrincipalSignOnProviderExistingApp":{"id":"components/schemas/WorkloadPrincipalSignOnProviderExistingApp","kind":"json-schema","title":"WorkloadPrincipalSignOnProviderExistingApp","data":{"description":"Binds the workload principal to an existing app instance.","type":"object","properties":{"appInstanceId":{"type":"string","description":"ID of the app instance to bind the workload principal to.","example":"0oaExistingApp123"},"type":{"type":"string","enum":["EXISTING_APP"],"example":"EXISTING_APP"}},"required":["type","appInstanceId"]}},"components/schemas/WorkloadPrincipalSignOnProviderNewOidcApp":{"id":"components/schemas/WorkloadPrincipalSignOnProviderNewOidcApp","kind":"json-schema","title":"WorkloadPrincipalSignOnProviderNewOidcApp","data":{"description":"Provisions a new OIDC app and binds it to the workload principal.","type":"object","properties":{"type":{"type":"string","enum":["NEW_OIDC_APP"],"example":"NEW_OIDC_APP"}},"required":["type"]}},"components/schemas/WorkloadPrincipalSignOnProviderRequest":{"id":"components/schemas/WorkloadPrincipalSignOnProviderRequest","kind":"json-schema","title":"WorkloadPrincipalSignOnProviderRequest","data":{"description":"Sign-on provider to bind to the workload principal.","oneOf":[{"$ref":"#/components/schemas/WorkloadPrincipalSignOnProviderNewOidcApp"},{"$ref":"#/components/schemas/WorkloadPrincipalSignOnProviderExistingApp"}],"discriminator":{"propertyName":"type","mapping":{"NEW_OIDC_APP":"#/components/schemas/WorkloadPrincipalSignOnProviderNewOidcApp","EXISTING_APP":"#/components/schemas/WorkloadPrincipalSignOnProviderExistingApp"}}}},"components/schemas/secures-ai-workload-principals-components-schemas-agentpublickeymoderequest-type":{"id":"components/schemas/secures-ai-workload-principals-components-schemas-agentpublickeymoderequest-type","kind":"json-schema","title":"secures-ai-workload-principals-components-schemas-agentpublickeymoderequest-type","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The active key source mode. JWKS uses inline JWK entries stored on the agent; JWKS_URI uses an external JWKS endpoint. Both sources may coexist in storage — this field is the sole authority on which is used during token verification."},"children":[]}]}]}],"type":"string","enum":["JWKS","JWKS_URI"]}},"schema_2009":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","maxLength":1024},"id":"schema_2009"},"schema_2010":{"kind":"json-schema","data":{"type":"string","minLength":3,"maxLength":50,"example":"agent"},"id":"schema_2010"},"schema_2011":{"kind":"json-schema","data":{"type":"string"},"id":"schema_2011"},"schema_2012":{"kind":"json-schema","data":{"type":"integer","minimum":1,"maximum":200,"default":20},"id":"schema_2012"},"schema_2013":{"kind":"json-schema","data":{"type":"object","properties":{"Link":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}]},"X-Rate-Limit-Limit":{"type":"integer","minimum":1,"example":60,"description":"The rate-limit ceiling for the current request"},"X-Rate-Limit-Remaining":{"type":"integer","minimum":0,"example":60,"description":"The number of requests left for the current rate-limit window"},"X-Rate-Limit-Reset":{"type":"integer","minimum":0,"example":1609459200,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)"}},"required":["X-Rate-Limit-Limit","X-Rate-Limit-Remaining","X-Rate-Limit-Reset"]},"id":"schema_2013"},"schema_2014":{"kind":"json-schema","data":{"type":"string","example":"wlpkhjm0jnDp8RrUu0g4"},"id":"schema_2014"},"schema_2015":{"kind":"json-schema","data":{"type":"string","example":"mcn1a2b3c4d5e6f7g8h9"},"id":"schema_2015"},"schema_2016":{"kind":"json-schema","data":{"type":"string","example":"wlpcFogtKCrK9aYq3fgV"},"id":"schema_2016"},"schema_2017":{"kind":"json-schema","data":{"type":"object","required":["data","_links"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AgentJsonSigningKeyResponse"}},"_links":{"$ref":"#/components/schemas/LinksSelf"}}},"id":"schema_2017"},"schema_2018":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","example":"profile.name sw \"Demo Agent\" and status eq \"ACTIVE\" and appId eq \"0oa1qmn4LZQQEH0wZ0g4\"","examples":["profile.name sw \"Demo Agent\" and status eq \"ACTIVE\"","signOnProvider.appInstanceId eq \"0oa1qmn4LZQQEH0wZ0g4\""]},"id":"schema_2018"},"schema_2019":{"kind":"json-schema","data":{"type":"string","enum":["createdDate","lastUpdate"]},"id":"schema_2019"},"schema_2020":{"kind":"json-schema","data":{"type":"string","default":"desc","enum":["asc","desc"]},"id":"schema_2020"},"schema_2021":{"kind":"json-schema","data":{"type":"object","required":["data","_links"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AIAgent"}},"_links":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}}},"id":"schema_2021"},"schema_2022":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://subdomain.okta.com/workload-principals/api/v1/operations/op-1a2b3c4d"}},"required":["Location"]},"id":"schema_2022"},"schema_2023":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","example":"type eq \"ai-agent:Import\" and status eq \"COMPLETED\""},"id":"schema_2023"},"schema_2024":{"kind":"json-schema","data":{"type":"string","example":"op-1a2b3c4d"},"id":"schema_2024"},"schema_2025":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","example":"sourceName eq \"salesforce\" and sourceId eq \"0oa1qmn4LZQQEH0wZ0g4\" and status eq \"ACTIVE\""},"id":"schema_2025"},"schema_2026":{"kind":"json-schema","data":{"type":"string","enum":["createdDate","lastUpdate","lastImportedDate","nextImportDate"]},"id":"schema_2026"},"schema_2027":{"kind":"json-schema","data":{"type":"object","properties":{"Link":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only present if there is another page of results."},"children":[]}]}]}]}]},"X-Rate-Limit-Limit":{"type":"integer","minimum":1,"example":60,"description":"The rate-limit ceiling for the current request"},"X-Rate-Limit-Remaining":{"type":"integer","minimum":0,"example":60,"description":"The number of requests left for the current rate-limit window"},"X-Rate-Limit-Reset":{"type":"integer","minimum":0,"example":1609459200,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)"}},"required":["X-Rate-Limit-Limit","X-Rate-Limit-Remaining","X-Rate-Limit-Reset"]},"id":"schema_2027"},"schema_2028":{"kind":"json-schema","data":{"type":"string","example":"aip-1a2b3c4d"},"id":"schema_2028"},"schema_2029":{"kind":"json-schema","data":{"type":"object","properties":{"Link":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]}]}]}]},"X-Rate-Limit-Limit":{"type":"integer","minimum":1,"example":60,"description":"The rate-limit ceiling for the current request"},"X-Rate-Limit-Remaining":{"type":"integer","minimum":0,"example":60,"description":"The number of requests left for the current rate-limit window"},"X-Rate-Limit-Reset":{"type":"integer","minimum":0,"example":1609459200,"description":"The time when the rate limit resets, specified in UTC epoch time (in seconds)"},"Location":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for import status if triggered. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]}]}]}],"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"required":["X-Rate-Limit-Limit","X-Rate-Limit-Remaining","X-Rate-Limit-Reset"]},"id":"schema_2029"},"schema_2030":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for import status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"required":["Location"]},"id":"schema_2030"},"schema_2031":{"kind":"json-schema","data":{"type":"string","format":"scim-filter"},"id":"schema_2031"},"schema_2032":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["appMetadata","agentMetadata","customAuthorizationServerMetadata"]}},"id":"schema_2032"},"schema_2033":{"kind":"json-schema","data":{"type":"string","example":"dlk1a2b3c4d5e6f7g8h9"},"id":"schema_2033"},"schema_2034":{"kind":"json-schema","data":{"type":"string","example":"wlp1aB2cD3eF4gH5iJ6k"},"id":"schema_2034"},"schema_2035":{"kind":"json-schema","data":{"type":"string","enum":["inputSchema"]},"id":"schema_2035"},"schema_2036":{"kind":"json-schema","data":{"type":"object","required":["data","_links"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualMCPCapability"}},"_links":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"},{"type":"object","properties":{"parent":{"$ref":"#/components/schemas/VirtualMCPConnectionHrefObjectParentLink"}}}]}}},"id":"schema_2036"},"schema_2037":{"kind":"json-schema","data":{"type":"object","properties":{"Link":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A link to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"self"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"blockquote","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Note:"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"next"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is only present if there is another page of results."},"children":[]}]}]}]}]}}},"id":"schema_2037"},"schema_2038":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-resource-servers/resourceserveroperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Server Operations API"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://{yourOktaDomain}/resource-servers/api/v1/operations/op-1a2b3c4d"}},"required":["Location"]},"id":"schema_2038"},"schema_2039":{"kind":"json-schema","data":{"type":"string","example":"vsc1aB2cD3eF4gH5iJ6k"},"id":"schema_2039"},"schema_2040":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","example":"profile.displayName sw \"Production\" and status eq \"ACTIVE\""},"id":"schema_2040"},"schema_2041":{"kind":"json-schema","data":{"type":"object","required":["data","_links"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VirtualMCP"}},"_links":{"allOf":[{"$ref":"#/components/schemas/LinksSelf"},{"$ref":"#/components/schemas/LinksNext"}]}}},"id":"schema_2041"},"schema_2042":{"kind":"json-schema","data":{"type":"object","properties":{"Location":{"type":"string","format":"uri","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"URL to poll for operation status. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/secures-ai/openapi/secures-ai-workload-principals/agentoperations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI Agent Operations"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"example":"https://{yourOktaDomain}/workload-principals/api/v1/operations/op-1a2b3c4d"}},"required":["Location"]},"id":"schema_2042"}},"exampleStore":{"components/examples/AIAgentBulkStagingActionOperationCompletedResponse":{"id":"components/examples/AIAgentBulkStagingActionOperationCompletedResponse","value":{"id":"op-6g7h8i9j","type":"ai-agent:BulkStaging","status":"COMPLETED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:50.000Z","operationMetadata":{"results":[{"id":"aic-1a2b3c4d","status":"SUCCESS","aiAgentId":"aiAgent_abc123def456"},{"id":"aic-5e6f7g8h","status":"SUCCESS","aiAgentId":"aiAgent_ghi789jkl012"},{"id":"aic-9i0j1k2l","status":"FAILURE","error":{"message":"Staging item is not in a valid state for this action"}}]}},"summary":"Completed AI agent bulk staging action operation response"},"components/examples/AIAgentBulkStagingActionOperationFailedResponse":{"id":"components/examples/AIAgentBulkStagingActionOperationFailedResponse","value":{"id":"op-6g7h8i9j","type":"ai-agent:BulkStaging","status":"FAILED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:50.000Z","errorDetails":{"code":"E0000001","message":"Failed to process bulk staging action"}},"summary":"Failed AI agent bulk staging action operation response"},"components/examples/AIAgentBulkStagingActionOperationInProgressResponse":{"id":"components/examples/AIAgentBulkStagingActionOperationInProgressResponse","value":{"id":"op-6g7h8i9j","type":"ai-agent:BulkStaging","status":"IN_PROGRESS","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z"},"summary":"In-progress AI agent bulk staging action operation response"},"components/examples/AIAgentImportOperationCompletedResponse":{"id":"components/examples/AIAgentImportOperationCompletedResponse","value":{"id":"op-1a2b3c5d","type":"ai-agent:Import","status":"COMPLETED","operationMetadata":{"sourceName":"SALESFORCE","sourceId":"0oa3omz2i9XRNSRIHBZO","importProgress":{"scanned":2,"added":1,"removed":1,"changed":0,"unchanged":0}},"created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z"},"summary":"Completed AI agent import operation response"},"components/examples/AIAgentOperationCompletedResponse":{"id":"components/examples/AIAgentOperationCompletedResponse","value":{"id":"op-1a2b3c4d","type":"ai-agent:Register","status":"COMPLETED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z","resource":{"id":"aiAgent_abc123def456","type":"ai_agent","status":"ACTIVE","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/ai-agents/aiAgent_abc123def456"}}}},"summary":"Completed AI agent operation response"},"components/examples/AIAgentOperationFailedResponse":{"id":"components/examples/AIAgentOperationFailedResponse","value":{"id":"op-2b3c4d5e","type":"ai-agent:Delete","status":"FAILED","created":"2025-09-10T14:30:00.000Z","started":"2025-09-10T14:30:01.000Z","completed":"2025-09-10T14:30:05.000Z","errorDetails":{"code":"E0000001","message":"custom error message."}},"summary":"Failed AI agent operation response"},"components/examples/AIAgentOperationInProgressResponse":{"id":"components/examples/AIAgentOperationInProgressResponse","value":{"id":"op-0f1e2d3c","type":"ai-agent:Replace","status":"IN_PROGRESS","created":"2025-09-10T15:00:00.000Z","started":"2025-09-10T15:00:01.000Z"},"summary":"In-progress AI agent operation response"},"components/examples/AIAgentProviderAttributesResponse":{"id":"components/examples/AIAgentProviderAttributesResponse","value":{"data":["source.Id","source.Description","source.MasterLabel"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/provider-attributes/salesforce"}}},"summary":"AI Agent Provider Attributes"},"components/examples/AIAgentProviderCreateSuccessResponse":{"id":"components/examples/AIAgentProviderCreateSuccessResponse","value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"summary":"A created AI agent provider"},"components/examples/AIAgentProviderGetSuccessResponse":{"id":"components/examples/AIAgentProviderGetSuccessResponse","value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"summary":"An active AI agent provider"},"components/examples/AIAgentProviderProfileMappingRequest":{"id":"components/examples/AIAgentProviderProfileMappingRequest","value":{"propertyMappings":[{"targetField":"agentName","sourceExpression":"source.agentName"},{"targetField":"agentDescription","sourceExpression":"source.agentDescription"},{"targetField":"agentPlatform","sourceExpression":"source.agentPlatform"},{"targetField":"externalID","sourceExpression":"source.agentID"}]},"summary":"Update profile mappings for an AI agent provider"},"components/examples/AIAgentProviderProfileMappingResponse":{"id":"components/examples/AIAgentProviderProfileMappingResponse","value":{"propertyMappings":[{"targetField":"agentName","sourceExpression":"source.agentName"},{"targetField":"agentDescription","sourceExpression":"source.agentDescription"},{"targetField":"agentPlatform","sourceExpression":"source.agentPlatform"},{"targetField":"externalID","sourceExpression":"source.agentID"}]},"summary":"Profile mappings for an AI agent provider"},"components/examples/AIAgentProviderSourcePriorityListSuccessResponse":{"id":"components/examples/AIAgentProviderSourcePriorityListSuccessResponse","value":{"data":[{"id":"0oafxqCAJWWGELFTYASJ","priority":10,"providerId":"aip-a1b2c3d4","enabledPlatforms":["SALESFORCE_AGENTFORCE"]},{"id":"0oa1qmn4LZQQEH0wZ0g4","priority":20,"providerId":"aip-e5f6g7h8","enabledPlatforms":["AWS_BEDROCK_AGENTS","AWS_BEDROCK_AGENTCORE"]}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/priorities"}}},"summary":"The current integration source priority order"},"components/examples/AIAgentProviderStatsListSuccessResponse":{"id":"components/examples/AIAgentProviderStatsListSuccessResponse","value":{"data":[{"providerId":"aip-1a2b3c4d","agentCount":42},{"providerId":"aip-5e6f7g8h","agentCount":7}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/stats?ids=aip-1a2b3c4d,aip-5e6f7g8h"}}},"summary":"Stats for the requested AI agent providers"},"components/examples/AIAgentProviderStatsWithMappedAttributeCountSuccessResponse":{"id":"components/examples/AIAgentProviderStatsWithMappedAttributeCountSuccessResponse","value":{"data":[{"providerId":"aip-1a2b3c4d","agentCount":42,"mappedAttributeCount":5},{"providerId":"aip-5e6f7g8h","agentCount":7,"mappedAttributeCount":0}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/stats?ids=aip-1a2b3c4d,aip-5e6f7g8h"}}},"summary":"Stats for the requested AI agent providers including mapped attribute counts"},"components/examples/AIAgentProviderStatsWithStagedCountsSuccessResponse":{"id":"components/examples/AIAgentProviderStatsWithStagedCountsSuccessResponse","value":{"data":[{"providerId":"aip-1a2b3c4d","agentCount":42,"stagedAgentCount":3},{"providerId":"aip-5e6f7g8h","agentCount":7,"stagedAgentCount":0}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/stats?ids=aip-1a2b3c4d,aip-5e6f7g8h"}}},"summary":"Stats for the requested AI agent providers including staged (unconfirmed) agent counts"},"components/examples/AIAgentProviderWithScheduleCreateSuccessResponse":{"id":"components/examples/AIAgentProviderWithScheduleCreateSuccessResponse","value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","nextScheduledImportDate":"2024-07-01T12:00:00Z","schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"summary":"A created AI agent provider with a schedule"},"components/examples/AIAgentProviderWithScheduleGetSuccessResponse":{"id":"components/examples/AIAgentProviderWithScheduleGetSuccessResponse","value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","nextScheduledImportDate":"2024-07-01T12:00:00Z","schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"summary":"An active AI agent provider with a schedule"},"components/examples/AIAgentProviderWithUnifyIdentityResponse":{"id":"components/examples/AIAgentProviderWithUnifyIdentityResponse","value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","stage":"AUTO_MERGE","deDupExpression":"target.profile.externalId eq source.profile.externalId","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"summary":"An AI agent provider with identity unification settings"},"components/examples/AIAgentProvidersListSuccessResponse":{"id":"components/examples/AIAgentProvidersListSuccessResponse","value":{"data":[{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/id"}}},{"id":"id2","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASK","sourceId":"appId2","sourceName":"Salesforce","sourceType":"apps","status":"INACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"groupOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:0og10sfroCwbHQO4a0g4"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/id2"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers"}}},"summary":"A list of active AI agent providers"},"components/examples/AIAgentReplaceSourcePriorityOperationCompletedResponse":{"id":"components/examples/AIAgentReplaceSourcePriorityOperationCompletedResponse","value":{"id":"op-7k8l9m0n","type":"ai-agent:ReplaceSourcePriority","status":"COMPLETED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:50.000Z"},"summary":"Completed replace source priority operation response"},"components/examples/AIAgentReplaceSourcePriorityOperationFailedResponse":{"id":"components/examples/AIAgentReplaceSourcePriorityOperationFailedResponse","value":{"id":"op-7k8l9m0n","type":"ai-agent:ReplaceSourcePriority","status":"FAILED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:49.000Z","completed":"2025-09-11T18:52:50.000Z","errorDetails":{"code":"INTERNAL_SERVER_ERROR","message":"Failed to apply priority changes"}},"summary":"Failed replace source priority operation response"},"components/examples/AIAgentReplaceSourcePriorityOperationInProgressResponse":{"id":"components/examples/AIAgentReplaceSourcePriorityOperationInProgressResponse","value":{"id":"op-7k8l9m0n","type":"ai-agent:ReplaceSourcePriority","status":"IN_PROGRESS","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:49.000Z"},"summary":"In-progress replace source priority operation response"},"components/examples/AIAgentResponse":{"id":"components/examples/AIAgentResponse","value":{"id":"wlpx9jQ16k9V8IFEL0g3","externalId":"3SSZFQL7OU","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"},"providers":[{"rel":"provider","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d","method":"GET"},{"rel":"provider","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-4e5f6g7h","method":"GET"}]}},"summary":"AI agent with an A2A server"},"components/examples/AIAgentResponseStaged":{"id":"components/examples/AIAgentResponseStaged","value":{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"STAGED","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}}},"components/examples/AIAgentResponseWithCIMD":{"id":"components/examples/AIAgentResponseWithCIMD","value":{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"STAGED","profile":{"name":"Demo Agent","description":"Demo Agent"},"oauthClient":{"clientId":"https://agent.example.com/metadata.json"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}},"summary":"AI agent registered with a CIMD OAuth client"},"components/examples/AIAgentResponseWithDelegationLinksNoAppId":{"id":"components/examples/AIAgentResponseWithDelegationLinksNoAppId","value":{"id":"wlpx9jQ16k9V8IFEL0g3","externalId":"3SSZFQL7OU","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"}}},"summary":"AI agent with delegation links (appId deprecated)"},"components/examples/AIAgentResponseWithProfileExternalId":{"id":"components/examples/AIAgentResponseWithProfileExternalId","value":{"id":"wlpx8kR27j0U7HGDM1h4","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Bedrock Agent","description":"AWS Bedrock Conversational AI Agent","externalId":"my-external-agent-id","platform":"AWS_BEDROCK_AGENTS"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx8kR27j0U7HGDM1h4","method":"GET"},"providers":[{"rel":"provider","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d","method":"GET"}]}},"summary":"AI agent with external identity in profile"},"components/examples/AIAgentResponseWithSignOnProvider":{"id":"components/examples/AIAgentResponseWithSignOnProvider","value":{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Demo Agent","description":"Demo Agent"},"oauthClient":{"clientId":"wlpx9jQ16k9V8IFEL0g3"},"signOnProvider":{"appInstanceId":"0oaNewApp4561a2b3c4d"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}},"summary":"AI agent with bound sign-on provider"},"components/examples/AIAgentResponseWithSources":{"id":"components/examples/AIAgentResponseWithSources","value":{"id":"wlpx8kR27j0U7HGDM1h4","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Bedrock Agent","description":"AWS Bedrock Conversational AI Agent","externalId":"arn:aws:bedrock:us-east-1:000000000:agent/ABCDEFGAG","platform":"AWS_BEDROCK_AGENTS"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx8kR27j0U7HGDM1h4","method":"GET"}},"_embedded":{"sources":{"Salesforce App":[{"Id":"16jWe0000004sMnIAI","MasterLabel":"Einstein Sales Agent","Description":"Einstein Sales Test Agent"}],"AWS Identity Center":[{"agentClassicSummary":{"agentId":"ABCDEFGAG","agentName":"Bedrock Agent","agentStatus":"PREPARED"},"agentClassicDetail":{"agentArn":"arn:aws:bedrock:us-east-1:000000000:agent/ABCDEFGAG"}}]}}},"summary":"AI agent with sources expanded"},"components/examples/AIAgentResponseWithoutA2A":{"id":"components/examples/AIAgentResponseWithoutA2A","value":{"id":"wlpx8kR27j0U7HGDM1h4","externalId":"7TTZGRL8PV","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","platform":"OKTA","profile":{"name":"Orchestrator Agent","description":"Orchestrator Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx8kR27j0U7HGDM1h4","method":"GET"},"providers":[{"rel":"provider","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d","method":"GET"}]}},"summary":"AI agent without an A2A server"},"components/examples/AIAgentSchemaResponse":{"id":"components/examples/AIAgentSchemaResponse","value":{"id":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/schema/default","$schema":"http://json-schema.org/draft-04/schema#","name":"AI Agent","title":"AI Agent","description":"Okta AI Agent profile","created":"2024-01-01T00:00:00.000Z","lastUpdated":"2024-01-01T00:00:00.000Z","definitions":{"base":{"id":"#base","type":"object","properties":{"name":{"title":"Name","type":"string","mutability":"READ_WRITE","scope":"NONE","master":{"type":"PROFILE_MASTER"}},"description":{"title":"Description","type":"string","mutability":"READ_WRITE","scope":"NONE","master":{"type":"PROFILE_MASTER"}},"platform":{"title":"Platform","type":"string","mutability":"READ_WRITE","scope":"NONE","master":{"type":"PROFILE_MASTER"}},"externalId":{"title":"External ID","type":"string","mutability":"READ_WRITE","scope":"NONE","master":{"type":"PROFILE_MASTER"}}},"required":["name"]},"custom":{"id":"#custom","type":"object","properties":{}}},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/schema/default","method":"GET"}}},"summary":"AI Agent Schema"},"components/examples/AIAgentSchemaUpdateRequest":{"id":"components/examples/AIAgentSchemaUpdateRequest","value":{"definitions":{"custom":{"properties":{"department":{"title":"Department","type":"string","description":"The department that owns this AI agent","mutability":"READ_WRITE","required":false}}}}},"summary":"Add a custom property to the AI agent schema"},"components/examples/AIAgentStagingActionOperationCompletedResponse":{"id":"components/examples/AIAgentStagingActionOperationCompletedResponse","value":{"id":"op-5f6g7h8i","type":"ai-agent:Staging","status":"COMPLETED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z","operationMetadata":{"results":[{"id":"aic-1a2b3c4d","status":"SUCCESS","aiAgentId":"aiAgent_abc123def456"}]}},"summary":"Completed AI agent staging action operation response"},"components/examples/AIAgentStagingActionOperationFailedResponse":{"id":"components/examples/AIAgentStagingActionOperationFailedResponse","value":{"id":"op-5f6g7h8i","type":"ai-agent:Staging","status":"FAILED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z","errorDetails":{"code":"E0000001","message":"Staging item is not in a valid state for this action"}},"summary":"Failed AI agent staging action operation response"},"components/examples/AIAgentStagingActionOperationInProgressResponse":{"id":"components/examples/AIAgentStagingActionOperationInProgressResponse","value":{"id":"op-5f6g7h8i","type":"ai-agent:Staging","status":"IN_PROGRESS","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z"},"summary":"In-progress AI agent staging action operation response"},"components/examples/AIAgentStagingBulkActionRequest":{"id":"components/examples/AIAgentStagingBulkActionRequest","value":{"ids":["aic-1a2b3c4d","aic-5e6f7g8h","aic-9i0j1k2l"]},"summary":"A request to bulk register staging items"},"components/examples/AIAgentStagingGetSuccessResponse":{"id":"components/examples/AIAgentStagingGetSuccessResponse","value":{"type":"DUPLICATE","incomingAgent":{"status":"STAGED","profile":{"name":"Demo Agent","externalId":"my-external-agent-id","platform":"SALESFORCE_AGENTFORCE"},"_embedded":{"sources":{"Salesforce":[{"agentName":"Demo Agent","externalId":"my-external-agent-id","platform":"agentforce"}]}}},"existingAgent":{"id":"wlpx9jQ16k9V8IFEL0g4","status":"ACTIVE","profile":{"name":"Demo Agent","externalId":"my-external-agent-id","platform":"SALESFORCE_AGENTFORCE"},"_embedded":{"sources":{"Salesforce":[{"agentName":"Demo Agent","externalId":"my-external-agent-id","platform":"agentforce"}]}}}},"summary":"A staging item for an AI agent provider"},"components/examples/AIAgentStagingListSuccessResponse":{"id":"components/examples/AIAgentStagingListSuccessResponse","value":{"data":[{"type":"DUPLICATE","incomingAgent":{"status":"STAGED","profile":{"name":"Demo Agent","externalId":"my-external-agent-id","platform":"SALESFORCE_AGENTFORCE"},"_embedded":{"sources":{"Salesforce":[{"agentName":"Demo Agent","externalId":"my-external-agent-id","platform":"agentforce"}]}}},"existingAgent":{"id":"wlpx9jQ16k9V8IFEL0g4","status":"ACTIVE","profile":{"name":"Demo Agent","externalId":"my-external-agent-id","platform":"SALESFORCE_AGENTFORCE"},"_embedded":{"sources":{"Salesforce":[{"agentName":"Demo Agent","externalId":"my-external-agent-id","platform":"agentforce"}]}}}},{"type":"NEW","incomingAgent":{"status":"STAGED","profile":{"name":"New Agent","externalId":"new-external-agent-id","platform":"SALESFORCE_AGENTFORCE"},"_embedded":{"sources":{"Salesforce":[{"agentName":"New Agent","externalId":"new-external-agent-id","platform":"agentforce"}]}}}},{"type":"IGNORED","incomingAgent":{"status":"INACTIVE","profile":{"name":"Ignored Agent","externalId":"ignored-external-agent-id","platform":"SALESFORCE_AGENTFORCE"},"_embedded":{"sources":{"Salesforce":[{"agentName":"Ignored Agent","externalId":"ignored-external-agent-id","platform":"agentforce"}]}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d/staging"}}},"summary":"A list of staging items for an AI agent provider"},"components/examples/AIAgentStagingReviewSuccessResponse":{"id":"components/examples/AIAgentStagingReviewSuccessResponse","value":{"type":"DUPLICATE","matchingCriteria":"agent.profile.externalId eq 16jWe0000004jg5IAA and agent.profile.platform eq SALESFORCE_AGENTFORCE","incomingAgent":{"agent":{"status":"STAGED","profile":{"name":"IT helpdesk Bot","description":"Helpdesk agent","platform":"SALESFORCE_AGENTFORCE","externalId":"agt_8f3k2p","creator":"jsmith@okta.corp"},"_embedded":{"sources":{"Salesforce":[{"agentDescription":"Helpdesk agent","agentName":"IT Helpdesk Bot","agentId":"agent3kd8s","platform":"agentforce"}]}}},"sourceId":"0oa1qmn4LZQQEH0wZ0g4","sourcePriority":2},"existingAgent":{"agent":{"id":"wlpx9jQ16k9V8IFEL0g4","status":"ACTIVE","profile":{"name":"IT helpdesk Agent","description":"Helpdesk agent","platform":"SALESFORCE_AGENTFORCE","externalId":"agt_8f3k2p"},"_embedded":{"sources":{}}}},"attributeDifferences":[{"attribute":"name","incomingValue":"IT helpdesk Bot","existingValue":"IT helpdesk Agent","status":"OVERWRITING"},{"attribute":"description","incomingValue":"Helpdesk agent","existingValue":"Helpdesk agent","status":"MATCH"},{"attribute":"platform","incomingValue":"SALESFORCE_AGENTFORCE","existingValue":"SALESFORCE_AGENTFORCE","status":"MATCH"},{"attribute":"externalId","incomingValue":"agt_8f3k2p","existingValue":"agt_8f3k2p","status":"MATCH"},{"attribute":"creator","incomingValue":"jsmith@okta.corp","existingValue":null,"status":"OVERWRITING"}]},"summary":"A review of a duplicate staging item"},"components/examples/AIAgentStagingStatsSuccessResponse":{"id":"components/examples/AIAgentStagingStatsSuccessResponse","value":{"newCount":15,"duplicateCount":3,"ignoredCount":7},"summary":"Staging stats for an AI agent provider"},"components/examples/AgentSettingsResponse":{"id":"components/examples/AgentSettingsResponse","value":{"supportedConnectionTypes":["IDENTITY_ASSERTION_CUSTOM_AS","STS_VAULT_SECRET","STS_SERVICE_ACCOUNT","STS_ACCESS_TOKEN"],"maxAgents":10000,"features":["multiAgentAssignment"]},"summary":"AI Agents Settings"},"components/examples/AgentSettingsResponseSupportedPlatforms":{"id":"components/examples/AgentSettingsResponseSupportedPlatforms","value":{"supportedConnectionTypes":["IDENTITY_ASSERTION_CUSTOM_AS","STS_VAULT_SECRET","STS_SERVICE_ACCOUNT","STS_ACCESS_TOKEN"],"maxAgents":10000,"features":["multiAgentAssignment"],"supportedPlatforms":["AWS_BEDROCK_AGENTS","AWS_BEDROCK_AGENTCORE","SALESFORCE_AGENTFORCE","SERVICENOW"]},"summary":"AI Agents Settings with supported platforms"},"components/examples/CreateAIAgentProviderRequest":{"id":"components/examples/CreateAIAgentProviderRequest","value":{"sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]}},"summary":"A request to create a new AI agent provider"},"components/examples/CreateAIAgentProviderWithScheduleRequest":{"id":"components/examples/CreateAIAgentProviderWithScheduleRequest","value":{"sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]}},"summary":"A request to create a new AI agent provider with a schedule"},"components/examples/CreateAIAgentProviderWithUnifyIdentityRequest":{"id":"components/examples/CreateAIAgentProviderWithUnifyIdentityRequest","value":{"sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"stage":"AUTO_MERGE","deDupExpression":"target.profile.externalId eq source.profile.externalId","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"summary":"A request to create a new AI agent provider with identity unification settings"},"components/examples/CreateAIAgentRequest":{"id":"components/examples/CreateAIAgentRequest","value":{"appId":"0oab1234EXAMPLEID5d6","resourceUrl":"https://demo-agent.example.com","profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"}},"summary":"Create an AI agent with an A2A server"},"components/examples/CreateAIAgentRequestWithCIMD":{"id":"components/examples/CreateAIAgentRequestWithCIMD","value":{"profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"},"oauthClient":{"type":"CIMD","clientIdMatchPattern":"https://agent.example.com/metadata.json"}},"summary":"Create an AI agent with a CIMD OAuth client"},"components/examples/CreateAIAgentRequestWithCustomAttributes":{"id":"components/examples/CreateAIAgentRequestWithCustomAttributes","value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Compliance Agent","description":"Compliance automation agent","creator":"alice@example.com","department":"Legal"}},"summary":"Register an AI agent with custom profile attributes"},"components/examples/CreateAIAgentRequestWithExistingAppSignOnProvider":{"id":"components/examples/CreateAIAgentRequestWithExistingAppSignOnProvider","value":{"profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"},"signOnProvider":{"type":"EXISTING_APP","appInstanceId":"0oaExistingApp123"}},"summary":"Create an AI agent and bind it to an existing app instance"},"components/examples/CreateAIAgentRequestWithNewOidcAppSignOnProvider":{"id":"components/examples/CreateAIAgentRequestWithNewOidcAppSignOnProvider","value":{"profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"},"signOnProvider":{"type":"NEW_OIDC_APP"}},"summary":"Create an AI agent and bind it to a new OIDC app instance"},"components/examples/CreateAIAgentRequestWithProfileExternalId":{"id":"components/examples/CreateAIAgentRequestWithProfileExternalId","value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Bedrock Agent","description":"AWS Bedrock Conversational AI Agent","externalId":"my-external-agent-id","platform":"AWS_BEDROCK_AGENTS"}},"summary":"Create an AI agent with external identity in profile"},"components/examples/CreateAIAgentRequestWithoutA2A":{"id":"components/examples/CreateAIAgentRequestWithoutA2A","value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Orchestrator Agent","description":"Orchestrator AI Agent"}},"summary":"Create an AI agent without an A2A server"},"components/examples/CreateVirtualMCPRequest":{"id":"components/examples/CreateVirtualMCPRequest","value":{"resourcePath":"production","profile":{"displayName":"Production MCP Servers","description":"Groups all production MCP servers for the engineering team"}},"summary":"Create a virtual MCP"},"components/examples/ErrorAccessDenied":{"id":"components/examples/ErrorAccessDenied","value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"summary":"Access Denied"},"components/examples/ErrorAgentClientSecretNonAscii":{"id":"components/examples/ErrorAgentClientSecretNonAscii","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: client_secret","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"client_secret: ''client_secret'' must only contain printable ASCII: [x20-x7E]+"}]}},"components/examples/ErrorAgentClientSecretTooLong":{"id":"components/examples/ErrorAgentClientSecretTooLong","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: client_secret","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"client_secret: 'client_secret' can't be more than '100' characters long."}]}},"components/examples/ErrorAgentClientSecretTooShort":{"id":"components/examples/ErrorAgentClientSecretTooShort","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: client_secret","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"client_secret: 'client_secret' must be at least '14' characters long."}]}},"components/examples/ErrorAgentDeactivateTheOnlyClientSecret":{"id":"components/examples/ErrorAgentDeactivateTheOnlyClientSecret","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: AgentClientSecret","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't deactivate the only active client secret."}]}},"components/examples/ErrorAgentDeleteActiveClientSecret":{"id":"components/examples/ErrorAgentDeleteActiveClientSecret","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: AgentClientSecret","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't delete an active client secret. Deactivate the secret before deleting it."}]}},"components/examples/ErrorAgentDeleteActiveJsonWebKey":{"id":"components/examples/ErrorAgentDeleteActiveJsonWebKey","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't delete an active JSON Web Key. Deactivate the key before deleting it."}]}},"components/examples/ErrorAgentJsonWebKeyDuplicateKid":{"id":"components/examples/ErrorAgentJsonWebKeyDuplicateKid","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"All keys in the `jwks` must have a unique `kid`."}]}},"components/examples/ErrorAgentJsonWebKeyKidLengthTooShort":{"id":"components/examples/ErrorAgentJsonWebKeyKidLengthTooShort","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"RSA key length in the `jwks` is less than 2048 bits for the given key."}]}},"components/examples/ErrorAgentJsonWebKeyNonUniqueKid":{"id":"components/examples/ErrorAgentJsonWebKeyNonUniqueKid","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"Each key should have a unique `kid` when adding multiple keys."}]}},"components/examples/ErrorAgentJsonWebKeyTooManyKids":{"id":"components/examples/ErrorAgentJsonWebKeyTooManyKids","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't create a new key. You have reached the maximum number of keys allowed (50). To add another key, you must first delete an existing one."}]}},"components/examples/ErrorAgentMaxNumberOfSecrets":{"id":"components/examples/ErrorAgentMaxNumberOfSecrets","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: AgentClientSecret","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You've reached the maximum number of client secrets per AI agent."}]}},"components/examples/ErrorAgentOnlyOneActiveEncryptionKeyAllowed":{"id":"components/examples/ErrorAgentOnlyOneActiveEncryptionKeyAllowed","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"The client can have only one active encryption key in the `jwks`."}]}},"components/examples/ErrorApiValidationConflict":{"id":"components/examples/ErrorApiValidationConflict","value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"summary":"Conflict"},"components/examples/ErrorApiValidationFailed":{"id":"components/examples/ErrorApiValidationFailed","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"summary":"API Validation Failed"},"components/examples/ErrorDeactivateEncryptionKey":{"id":"components/examples/ErrorDeactivateEncryptionKey","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't deactivate the active encryption key."}]}},"components/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod":{"id":"components/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"Can't deactivate the only active JSON Web Key when the value for `token_endpoint_auth_method` is `private_key_jwt`."}]}},"components/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm":{"id":"components/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"The `jwks` must contain at least one key with an algorithm matching the `request_object_signature_algorithm`."}]}},"components/examples/ErrorInternalServer":{"id":"components/examples/ErrorInternalServer","value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000000","errorId":"sampleAlJ82XS2SDB_vaNIWgcA","errorCauses":[]},"summary":"Internal Server Error"},"components/examples/ErrorInvalidTokenProvided":{"id":"components/examples/ErrorInvalidTokenProvided","value":{"errorCode":"E0000011","errorSummary":"Invalid token provided","errorLink":"E0000011","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"summary":"Invalid Token Provided"},"components/examples/ErrorMissingRequiredParameter":{"id":"components/examples/ErrorMissingRequiredParameter","value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"sampleiCF-l7mr9XqM1NQ","errorCauses":[]},"summary":"Missing Required Parameter"},"components/examples/ErrorResourceNotFound":{"id":"components/examples/ErrorResourceNotFound","value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"summary":"Resource Not Found"},"components/examples/ErrorTooManyRequests":{"id":"components/examples/ErrorTooManyRequests","value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"summary":"Too Many Requests"},"components/examples/ListAIAgentsResponse":{"id":"components/examples/ListAIAgentsResponse","value":{"data":[{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?limit=1"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?after=wlpx9jQ16k9V8IFEL0&limit=1"}}},"summary":"List of AI agents"},"components/examples/ListAIAgentsResponseWithDelegationLinksNoAppId":{"id":"components/examples/ListAIAgentsResponseWithDelegationLinksNoAppId","value":{"data":[{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?limit=1"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?after=wlpx9jQ16k9V8IFEL0&limit=1"}}},"summary":"List of AI agents with delegation links (appId deprecated)"},"components/examples/ListAIAgentsResponseWithProfileExternalId":{"id":"components/examples/ListAIAgentsResponseWithProfileExternalId","value":{"data":[{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Bedrock Agent","description":"AWS Bedrock Conversational AI Agent","externalId":"my-external-agent-id","platform":"AWS_BEDROCK_AGENTS"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?limit=1"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?after=wlpx9jQ16k9V8IFEL0&limit=1"}}},"summary":"List of AI agents with external identity in profile"},"components/examples/ListAIAgentsResponseWithSignOnProvider":{"id":"components/examples/ListAIAgentsResponseWithSignOnProvider","value":{"data":[{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Demo Agent","description":"Demo Agent"},"oauthClient":{"clientId":"wlpx9jQ16k9V8IFEL0g3"},"signOnProvider":{"appInstanceId":"0oaNewApp4561a2b3c4d"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}},{"id":"wlpx8kR27j0U7HGDM1h4","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Orchestrator Agent","description":"Orchestrator Agent"},"oauthClient":{"clientId":"0oaExistingApp123"},"signOnProvider":{"appInstanceId":"0oaExistingApp123"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx8kR27j0U7HGDM1h4","method":"GET"}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?limit=2"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?after=wlpx8kR27j0U7HGDM1h4&limit=2"}}},"summary":"List of AI agents with sign-on provider state"},"components/examples/ListAIAgentsResponseWithSources":{"id":"components/examples/ListAIAgentsResponseWithSources","value":{"data":[{"id":"wlpx8kR27j0U7HGDM1h4","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Bedrock Agent","description":"AWS Bedrock Conversational AI Agent","externalId":"arn:aws:bedrock:us-east-1:000000000:agent/ABCDEFGAG","platform":"AWS_BEDROCK_AGENTS"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx8kR27j0U7HGDM1h4","method":"GET"}},"_embedded":{"sources":{"Salesforce App":[{"Id":"16jWe0000004sMnIAI","MasterLabel":"Einstein Sales Agent","Description":"Einstein Sales Test Agent"}],"AWS Identity Center":[{"agentClassicSummary":{"agentId":"ABCDEFGAG","agentName":"Bedrock Agent","agentStatus":"PREPARED"},"agentClassicDetail":{"agentArn":"arn:aws:bedrock:us-east-1:000000000:agent/ABCDEFGAG"}}]}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?expand=sources&limit=1"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?expand=sources&after=wlpx8kR27j0U7HGDM1h4&limit=1"}}},"summary":"List of AI agents with sources expanded"},"components/examples/ListVirtualMCPsResponse":{"id":"components/examples/ListVirtualMCPsResponse","value":{"data":[{"id":"wlp1aB2cD3eF4gH5iJ6k","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","status":"ACTIVE","profile":{"displayName":"Production MCP Servers","description":"Groups all production MCP servers for the engineering team"},"created":"2025-06-01T10:00:00Z","lastUpdated":"2025-06-15T14:30:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"}}},{"id":"wlp7lM8nO9pQ0rS1tU2v","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp7lM8nO9pQ0rS1tU2v","status":"INACTIVE","profile":{"displayName":"Staging MCP Servers","description":"Groups all staging MCP servers for testing"},"created":"2025-06-10T08:00:00Z","lastUpdated":"2025-06-10T08:00:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"}}},{"id":"wlp3wX4yZ5aB6cD7eF8g","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp3wX4yZ5aB6cD7eF8g","status":"ACTIVE","profile":{"displayName":"Development MCP Servers"},"created":"2025-06-12T12:00:00Z","lastUpdated":"2025-06-14T09:15:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp3wX4yZ5aB6cD7eF8g"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp3wX4yZ5aB6cD7eF8g"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers?limit=20"}}},"summary":"List of virtual MCPs"},"components/examples/PatchAIAgentRequestPartialRemoveAppIdAndDescription":{"id":"components/examples/PatchAIAgentRequestPartialRemoveAppIdAndDescription","value":{"appId":null,"profile":{"description":null}}},"components/examples/PatchAIAgentRequestPartialUpdateAppId":{"id":"components/examples/PatchAIAgentRequestPartialUpdateAppId","value":{"appId":"0oab1234EXAMPLEID5d6"}},"components/examples/PatchAIAgentRequestPartialUpdateCustomAttributes":{"id":"components/examples/PatchAIAgentRequestPartialUpdateCustomAttributes","value":{"profile":{"department":"Finance"}},"summary":"Update custom profile attributes"},"components/examples/PatchAIAgentRequestPartialUpdateName":{"id":"components/examples/PatchAIAgentRequestPartialUpdateName","value":{"profile":{"name":"Updated name only"}}},"components/examples/PatchAIAgentRequestPartialUpdateProfileExternalId":{"id":"components/examples/PatchAIAgentRequestPartialUpdateProfileExternalId","value":{"profile":{"externalId":"my-external-agent-id","platform":"AWS_BEDROCK_AGENTS"}},"summary":"Update externalId and platform in profile"},"components/examples/PatchAIAgentRequestPartialUpdateResourceUrl":{"id":"components/examples/PatchAIAgentRequestPartialUpdateResourceUrl","value":{"resourceUrl":"https://demo-agent.example.com"}},"components/examples/PatchAIAgentRequestUpdateValues":{"id":"components/examples/PatchAIAgentRequestUpdateValues","value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Updated name","description":"Updated description"}}},"components/examples/PatchAIAgentRequestWithCIMD":{"id":"components/examples/PatchAIAgentRequestWithCIMD","value":{"oauthClient":{"type":"CIMD","clientIdMatchPattern":"https://agent.example.com/metadata.json"}},"summary":"Register an existing AI agent as a CIMD OAuth client"},"components/examples/PatchAIAgentRequestWithExistingAppSignOnProvider":{"id":"components/examples/PatchAIAgentRequestWithExistingAppSignOnProvider","value":{"signOnProvider":{"type":"EXISTING_APP","appInstanceId":"0oaExistingApp123"}},"summary":"Bind an existing AI agent to an existing app instance"},"components/examples/PatchAIAgentRequestWithNewOidcAppSignOnProvider":{"id":"components/examples/PatchAIAgentRequestWithNewOidcAppSignOnProvider","value":{"signOnProvider":{"type":"NEW_OIDC_APP"}},"summary":"Bind an existing AI agent to a new OIDC app instance"},"components/examples/PatchVirtualMCPRequestUpdateProfile":{"id":"components/examples/PatchVirtualMCPRequestUpdateProfile","value":{"profile":{"displayName":"Updated Production MCP Servers","description":"Updated description for the production MCP server group"}},"summary":"Update display name and description"},"components/examples/ReplaceAIAgentProviderRequest":{"id":"components/examples/ReplaceAIAgentProviderRequest","value":{"configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"summary":"A request to replace an existing AI agent provider"},"components/examples/ReplaceAIAgentProviderSourcePrioritiesRequest":{"id":"components/examples/ReplaceAIAgentProviderSourcePrioritiesRequest","value":{"data":[{"id":"0oa1qmn4LZQQEH0wZ0g4"},{"id":"0oafxqCAJWWGELFTYASJ"}]},"summary":"A request to replace the full integration source priority order"},"components/examples/ReplaceAIAgentProviderWithScheduleRequest":{"id":"components/examples/ReplaceAIAgentProviderWithScheduleRequest","value":{"configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"summary":"A request to replace an existing AI agent provider with a schedule"},"components/examples/ReplaceAIAgentProviderWithUnifyIdentityRequest":{"id":"components/examples/ReplaceAIAgentProviderWithUnifyIdentityRequest","value":{"configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"stage":"NEWLY_IMPORTED","deDupExpression":"target.profile.externalId eq source.profile.externalId","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"summary":"A request to replace an existing AI agent provider with identity unification settings"},"components/examples/UpdateAIAgentProviderRequest":{"id":"components/examples/UpdateAIAgentProviderRequest","value":{"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"summary":"A request to update an existing AI agent provider"},"components/examples/UpdateAIAgentProviderWithScheduleRequest":{"id":"components/examples/UpdateAIAgentProviderWithScheduleRequest","value":{"schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"}},"summary":"A request to update an existing AI agent provider with a schedule"},"components/examples/UpdateAIAgentProviderWithUnifyIdentityRequest":{"id":"components/examples/UpdateAIAgentProviderWithUnifyIdentityRequest","value":{"stage":"DUPLICATE","deDupExpression":"target.profile.externalId eq source.profile.externalId"},"summary":"A request to update an existing AI agent provider with identity unification settings"},"components/examples/UpdateAIAgentRequest":{"id":"components/examples/UpdateAIAgentRequest","value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"}}},"components/examples/UpdateAIAgentRequestWithCustomAttributes":{"id":"components/examples/UpdateAIAgentRequestWithCustomAttributes","value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Compliance Agent","description":"Updated compliance automation agent","creator":"alice@example.com","department":"Finance"}},"summary":"Replace an AI agent profile including custom attributes"},"components/examples/UpdateAIAgentRequestWithProfileExternalId":{"id":"components/examples/UpdateAIAgentRequestWithProfileExternalId","value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Bedrock Agent","description":"AWS Bedrock Conversational AI Agent","externalId":"my-external-agent-id","platform":"AWS_BEDROCK_AGENTS"}},"summary":"Replace an AI agent with external identity in profile"},"components/examples/ValidateAIAgentProviderRequest":{"id":"components/examples/ValidateAIAgentProviderRequest","value":{"sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","configuration":{"clientId":"clientId","clientSecret":"clientSecret"}},"summary":"A request to validate an AI agent provider"},"components/examples/VirtualMCPOperationCompletedResponse":{"id":"components/examples/VirtualMCPOperationCompletedResponse","value":{"id":"op-4e5f6g7h","type":"virtual-mcp:Register","status":"COMPLETED","created":"2025-09-12T10:00:00.000Z","started":"2025-09-12T10:00:01.000Z","completed":"2025-09-12T10:00:03.000Z","resource":{"id":"vmcp_xyz789abc012","type":"ai_agent","status":"ACTIVE","_links":{"self":{"href":"https://subdomain.okta.com/workload-principal/api/v1/virtual-mcp-servers/vmcp_xyz789abc012"}}}},"summary":"Completed virtual MCP operation response"},"components/examples/VirtualMCPResponseActive":{"id":"components/examples/VirtualMCPResponseActive","value":{"id":"wlp1aB2cD3eF4gH5iJ6k","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","status":"ACTIVE","profile":{"displayName":"Production MCP Servers","description":"Groups all production MCP servers for the engineering team"},"created":"2025-06-01T10:00:00Z","lastUpdated":"2025-06-15T14:30:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"}}},"summary":"Active virtual MCP"},"components/examples/VirtualMCPResponseInactive":{"id":"components/examples/VirtualMCPResponseInactive","value":{"id":"wlp7lM8nO9pQ0rS1tU2v","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp7lM8nO9pQ0rS1tU2v","status":"INACTIVE","profile":{"displayName":"Staging MCP Servers","description":"Groups all staging MCP servers for testing"},"created":"2025-06-10T08:00:00Z","lastUpdated":"2025-06-10T08:00:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"}}},"summary":"Inactive virtual MCP"},"components/examples/VirtualMcpSettingsResponse":{"id":"components/examples/VirtualMcpSettingsResponse","value":{"supportedConnectionTypes":["STS_ACCESS_TOKEN"],"limits":{"maxVirtualMCPs":100,"maxCapabilitiesPerVirtualMCP":1000,"maxResourceServersPerVirtualMCP":100},"features":[],"basePath":"https://subdomain.gateway.okta.com"},"summary":"Virtual MCP Settings"},"components/examples/activate-resource-connection-response-example":{"id":"components/examples/activate-resource-connection-response-example","value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcnbcde12f3g4h5i6j7k","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcnbcde12f3g4h5i6j7k","status":"ACTIVE","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus1gjh63g214q0Hq0g4","name":"Custom CRM Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus1gjh63g214q0Hq0g4","type":"text/html"}}},"scopeCondition":"ALL_SCOPES","scopes":["*"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcnbcde12f3g4h5i6j7k"}}},"summary":"Activate a resource connection for a custom authorization server"},"components/examples/activate-virtual-mcp-connection-response-example":{"id":"components/examples/activate-virtual-mcp-connection-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"Activated virtual MCP connection"},"components/examples/activateAgentClientSecretResponse":{"id":"components/examples/activateAgentClientSecretResponse","value":{"id":"ocs2f50kZB0cITmYU0g4","status":"ACTIVE","client_secret":"DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B","secret_hash":"0WOOvBSzV9clc4Nr7Rbaug","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}},"summary":"Activate client secret response example"},"components/examples/add-virtual-mcp-connection-capability-with-alias-example":{"id":"components/examples/add-virtual-mcp-connection-capability-with-alias-example","value":{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","alias":"get_jira_issues"},"summary":"Add a capability with an alias"},"components/examples/add-virtual-mcp-connection-capability-without-alias-example":{"id":"components/examples/add-virtual-mcp-connection-capability-without-alias-example","value":{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k"},"summary":"Add a capability without an alias"},"components/examples/agentClientSecretListResponse":{"id":"components/examples/agentClientSecretListResponse","value":[{"id":"ocs2f4zrZbs8nUa7p0g4","status":"INACTIVE","client_secret":"DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B","secret_hash":"yk4SVx4sUWVJVbHt6M-UPA","created":"2023-02-21T20:08:24.000Z","lastUpdated":"2023-02-21T20:08:24.000Z","_links":{"activate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate","hints":{"allow":["POST"]}},"delete":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/secrets/ocs2f4zrZbs8nUa7p0g4","hints":{"allow":["DELETE"]}}}},{"id":"ocs2f50kZB0cITmYU0g4","status":"ACTIVE","client_secret":"HAGDTYU9XbLnS......3xasFDDwecdZuFs5B","secret_hash":"0WOOvBSzV9clc4Nr7Rbaug","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}}],"summary":"Client secrets list response example"},"components/examples/agentClientSecretResponse":{"id":"components/examples/agentClientSecretResponse","value":{"id":"ocs2f50kZB0cITmYU0g4","status":"ACTIVE","client_secret":"DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B","secret_hash":"FpCwXwSjTRQNtEI11I00-g","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/secrets/ocs2f50kZB0cITmYU0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}},"summary":"Client secret response example"},"components/examples/agentJsonWebKey":{"id":"components/examples/agentJsonWebKey","value":{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}},"summary":"RSA JSON Web Key example"},"components/examples/agentJsonWebKeyListResponse":{"id":"components/examples/agentJsonWebKeyListResponse","value":{"data":[{"id":"pks2f4zrZbs8nUa7p0g4","kid":"DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrKuine49_CEVR4GPn.....zOrouIUCSMlRL0HU=","status":"INACTIVE","created":"2023-02-21T20:08:24.000Z","lastUpdated":"2023-02-21T20:08:24.000Z","_links":{"activate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/activate","hints":{"allow":["POST"]}},"delete":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4","hints":{"allow":["DELETE"]}}}},{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks"}}},"summary":"JSON Web Key list response example"},"components/examples/agentJsonWebKeyRequest":{"id":"components/examples/agentJsonWebKeyRequest","value":{"kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE"},"summary":"RSA JSON Web Key request example"},"components/examples/create-delegation-link-agent-to-agent-access-token":{"id":"components/examples/create-delegation-link-agent-to-agent-access-token","value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"summary":"Link that allows an AI agent to delegate to another AI agent with an access token"},"components/examples/create-delegation-link-app-to-agent-access-token":{"id":"components/examples/create-delegation-link-app-to-agent-access-token","value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"summary":"Link that allows the app to delegate to an AI agent with an access token"},"components/examples/create-delegation-link-app-to-agent-id-token":{"id":"components/examples/create-delegation-link-app-to-agent-id-token","value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"summary":"Link that allows the app to delegate to an AI agent with an ID token"},"components/examples/create-delegation-link-app-to-vmcp-access-token":{"id":"components/examples/create-delegation-link-app-to-vmcp-access-token","value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:vms1aB2cD3eF4gH5iJ6k"}},"summary":"Link that allows an app to delegate to a virtual MCP server with an access token"},"components/examples/create-delegation-link-minimal":{"id":"components/examples/create-delegation-link-minimal","value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"summary":"Minimal delegation link with only required fields","description":"Creates a delegation link with only the resourceOrn field"},"components/examples/create-delegation-link-response":{"id":"components/examples/create-delegation-link-response","value":{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links/dlk1a2b3c4d5e6f7g8h9"}}},"summary":"A created delegation link"},"components/examples/create-delegation-link-with-auth-server":{"id":"components/examples/create-delegation-link-with-auth-server","value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"}},"summary":"The `ID_TOKEN` delegation link specifying a custom authorization server"},"components/examples/create-resource-connection-identity-assertion-a2a-server-example":{"id":"components/examples/create-resource-connection-identity-assertion-a2a-server-example","value":{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4"},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7"},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"]},"summary":"Create an identity assertion connection for an A2A server"},"components/examples/create-resource-connection-identity-assertion-custom-as-example":{"id":"components/examples/create-resource-connection-identity-assertion-custom-as-example","value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7"},"scopeCondition":"EXCLUDE","scopes":["crm.admin.delete","crm.admin.write"]},"summary":"Create an identity assertion connection for a custom authorization server"},"components/examples/create-resource-connection-identity-assertion-virtual-mcp-server-example":{"id":"components/examples/create-resource-connection-identity-assertion-virtual-mcp-server-example","value":{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k"},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7"},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"]},"summary":"Create an identity assertion connection for a virtual MCP server"},"components/examples/create-resource-connection-response-a2a-server-example":{"id":"components/examples/create-resource-connection-response-a2a-server-example","value":{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"INACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}},"summary":"A created resource connection for an A2A server"},"components/examples/create-resource-connection-response-example":{"id":"components/examples/create-resource-connection-response-example","value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn5e6f7g8h9i0j1k2l3","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn5e6f7g8h9i0j1k2l3","status":"INACTIVE","resourceIndicator":"https://api.custom-crm.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5t60iloOHN9pBi0h7","name":"Custom CRM Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5t60iloOHN9pBi0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5t60iloOHN9pBi0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5t60iloOHN9pBi0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.contacts.read","crm.accounts.write"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn5e6f7g8h9i0j1k2l3"}}},"summary":"A resource connection for a custom authorization server"},"components/examples/create-resource-connection-response-sts-access-token-api-server-example":{"id":"components/examples/create-resource-connection-response-sts-access-token-api-server-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://api.stripe.com","resource":{"resourceType":"API_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:api:api8nUa7p0g4zrZbs2f4","name":"Stripe API","apiServerId":"api8nUa7p0g4zrZbs2f4","resourceUrl":"https://api.stripe.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Stripe API OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/api-servers/api8nUa7p0g4zrZbs2f4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"A created STS access token resource connection for a third-party API server"},"components/examples/create-resource-connection-response-sts-access-token-example":{"id":"components/examples/create-resource-connection-response-sts-access-token-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn8h9i0j1k2l3m4n5o6","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn8h9i0j1k2l3m4n5o6","status":"INACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","resource":{"resourceType":"APP_INSTANCE","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa1gjh63g214q0Hq0g4","logo":"https://example.com/img/logos/github.png","appInstanceId":"0oa1gjh63g214q0Hq0g4","appInstanceName":"GitHub Enterprise","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","name":"GitHub Enterprise OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc1gjh63g214q0Hq0g4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa1gjh63g214q0Hq0g4#tab-resource-server","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn8h9i0j1k2l3m4n5o6"}}},"summary":"A created STS access token resource connection for an app instance"},"components/examples/create-resource-connection-response-sts-access-token-mcp-server-example":{"id":"components/examples/create-resource-connection-response-sts-access-token-mcp-server-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"A created STS access token resource connection for a third-party MCP server"},"components/examples/create-resource-connection-response-virtual-mcp-server-example":{"id":"components/examples/create-resource-connection-response-virtual-mcp-server-example","value":{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"INACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}},"summary":"A created resource connection for a virtual MCP server"},"components/examples/create-resource-connection-service-account-example":{"id":"components/examples/create-resource-connection-service-account-example","value":{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4"},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861"}},"summary":"Create a service account connection"},"components/examples/create-resource-connection-sts-access-token-api-server-example":{"id":"components/examples/create-resource-connection-sts-access-token-api-server-example","value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8"},"resourceIndicator":"https://api.stripe.com"},"summary":"Create an STS access token connection for a third-party API server"},"components/examples/create-resource-connection-sts-access-token-example":{"id":"components/examples/create-resource-connection-sts-access-token-example","value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4"}},"summary":"Create an STS access token connection for an app instance"},"components/examples/create-resource-connection-sts-access-token-mcp-server-example":{"id":"components/examples/create-resource-connection-sts-access-token-mcp-server-example","value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7"},"resourceIndicator":"https://mcp.example.com"},"summary":"Create an STS access token connection for a third-party MCP server"},"components/examples/create-resource-connection-vaulted-secret-example":{"id":"components/examples/create-resource-connection-vaulted-secret-example","value":{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a"}},"summary":"Create a vaulted secret connection"},"components/examples/create-virtual-mcp-connection-example":{"id":"components/examples/create-virtual-mcp-connection-example","value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7"},"resourceIndicator":"https://mcp.example.com"},"summary":"Create an STS access token connection for a third-party MCP server"},"components/examples/create-virtual-mcp-connection-response-example":{"id":"components/examples/create-virtual-mcp-connection-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"A created STS access token connection for a third-party MCP server"},"components/examples/createAgentClientSecretCustomRequestBody":{"id":"components/examples/createAgentClientSecretCustomRequestBody","value":{"client_secret":"DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B","status":"ACTIVE"},"summary":"Add a user-provided client secret"},"components/examples/createAgentClientSecretSystemGeneratedRequestBody":{"id":"components/examples/createAgentClientSecretSystemGeneratedRequestBody","value":{},"summary":"Add a system-generated client secret"},"components/examples/deactivate-resource-connection-response-example":{"id":"components/examples/deactivate-resource-connection-response-example","value":{"connectionType":"STS_VAULT_SECRET","id":"mcn0j1k2l3m4n5o6p7q8","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn0j1k2l3m4n5o6p7q8","status":"INACTIVE","resourceIndicator":"https://api.crm.company.com","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"Database Root Password","path":"/secrets/database/root-password","description":"Root password for production database server","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn0j1k2l3m4n5o6p7q8"}}},"summary":"A deactivated resource connection"},"components/examples/deactivate-virtual-mcp-connection-response-example":{"id":"components/examples/deactivate-virtual-mcp-connection-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"Deactivated virtual MCP connection"},"components/examples/deactivateAgentClientSecretResponse":{"id":"components/examples/deactivateAgentClientSecretResponse","value":{"id":"ocs2f4zrZbs8nUa7p0g4","status":"INACTIVE","client_secret":"DRUFXGF9XbLn......a3x3POBiIxDreBCdZuFs5B","secret_hash":"yk4SVx4sUWVJVbHt6M-UPA","created":"2023-02-21T20:08:24.000Z","lastUpdated":"2023-02-21T20:08:24.000Z","_links":{"activate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/secrets/ocs2f4zrZbs8nUa7p0g4/lifecycle/activate","hints":{"allow":["POST"]}},"delete":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/secrets/ocs2f4zrZbs8nUa7p0g4","hints":{"allow":["DELETE"]}}}},"summary":"Deactivate client secret response example"},"components/examples/deactivateAgentJsonWebKeyResponse":{"id":"components/examples/deactivateAgentJsonWebKeyResponse","value":{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"INACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"activate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/activate","hints":{"allow":["POST"]}}}},"summary":"Deactivate JSON Signing Key example"},"components/examples/get-delegation-link-custom-as":{"id":"components/examples/get-delegation-link-custom-as","value":{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links/dlk2b3c4d5e6f7g8h9i0"}}},"summary":"Retrieve a delegation link with an AI agent as the source","description":"Retrieves a delegation link from an AI agent to another AI agent"},"components/examples/get-delegation-link-org-as":{"id":"components/examples/get-delegation-link-org-as","value":{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links/dlk1a2b3c4d5e6f7g8h9"}}},"summary":"Retrieve a delegation link with an app as the source","description":"Retrieves a delegation link from an app to an AI agent"},"components/examples/get-resource-connection-identity-assertion-a2a-server-response-example":{"id":"components/examples/get-resource-connection-identity-assertion-a2a-server-response-example","value":{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}},"summary":"Get an identity assertion resource connection for an A2A server","description":"When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server"},"components/examples/get-resource-connection-identity-assertion-custom-as-response-example":{"id":"components/examples/get-resource-connection-identity-assertion-custom-as-response-example","value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:crm:0oa1gjh63g214q0Hq0g4","authorizationServer":{"orn":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server for CRM API","issuerUrl":"https://{yourOktaDomain}/oauth2/aus3m4n5k6l7p8q9r0s1","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.read","crm.write"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}},"summary":"Get an identity assertion resource connection for custom authorization server","description":"When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server"},"components/examples/get-resource-connection-identity-assertion-virtual-mcp-server-response-example":{"id":"components/examples/get-resource-connection-identity-assertion-virtual-mcp-server-response-example","value":{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}},"summary":"Get an identity assertion resource connection for a virtual MCP server","description":"When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server"},"components/examples/get-resource-connection-sts-access-token-api-server-response-example":{"id":"components/examples/get-resource-connection-sts-access-token-api-server-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://api.stripe.com","resource":{"resourceType":"API_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:api:api8nUa7p0g4zrZbs2f4","name":"Stripe API","apiServerId":"api8nUa7p0g4zrZbs2f4","resourceUrl":"https://api.stripe.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Stripe API OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/api-servers/api8nUa7p0g4zrZbs2f4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"Get an STS access token resource connection for a third-party API server","description":"When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings"},"components/examples/get-resource-connection-sts-access-token-mcp-server-response-example":{"id":"components/examples/get-resource-connection-sts-access-token-mcp-server-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"Get an STS access token resource connection for a third-party MCP server","description":"When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings"},"components/examples/get-resource-connection-sts-access-token-response-example":{"id":"components/examples/get-resource-connection-sts-access-token-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn8h9i0j1k2l3m4n5o6","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn8h9i0j1k2l3m4n5o6","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","resource":{"resourceType":"APP_INSTANCE","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa1gjh63g214q0Hq0g4","logo":"https://example.com/img/logos/github.png","appInstanceId":"0oa1gjh63g214q0Hq0g4","appInstanceName":"GitHub Enterprise","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","name":"GitHub Enterprise OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc1gjh63g214q0Hq0g4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa1gjh63g214q0Hq0g4#tab-resource-server","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn8h9i0j1k2l3m4n5o6"}}},"summary":"Get an STS access token resource connection for an app instance","description":"When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings"},"components/examples/get-resource-connection-sts-secret-response-example":{"id":"components/examples/get-resource-connection-sts-secret-response-example","value":{"connectionType":"STS_VAULT_SECRET","id":"mcn2b3c4d5e6f7g8h9i0","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn2b3c4d5e6f7g8h9i0","status":"ACTIVE","resourceIndicator":"https://api.crm.company.com","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"Database Root Password","path":"/secrets/database/root-password","description":"Root password for production database server","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn2b3c4d5e6f7g8h9i0"}}},"summary":"Get a vaulted secret resource connection","description":"When a resource connection enables a workload principal to obtain a vaulted secret credential"},"components/examples/get-resource-connection-sts-service-account-response-example":{"id":"components/examples/get-resource-connection-sts-service-account-response-example","value":{"connectionType":"STS_SERVICE_ACCOUNT","id":"mcn3c4d5e6f7g8h9i0j1","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn3c4d5e6f7g8h9i0j1","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4","name":"Test Org Custom SAML App","logo":"https://example.com/img/logos/custom-saml.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/admin/app/testorgone_customsaml20app_1/instance/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/testorgone_customsaml20app_1/instance/0oa1gjh63g214q0Hq0g4","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Test Org SAML Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn3c4d5e6f7g8h9i0j1"}}},"summary":"Get a service account resource connection","description":"When a resource connection enables a workload principal to obtain a service account credential"},"components/examples/get-virtual-mcp-connection-response-example":{"id":"components/examples/get-virtual-mcp-connection-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"Get an STS access token connection for a third-party MCP server"},"components/examples/list-agent-connections-example":{"id":"components/examples/list-agent-connections-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn4d5e6f7g8h9i0j1k2","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn4d5e6f7g8h9i0j1k2","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7","authorizationServer":{"orn":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Auth Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.read","crm.write"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn4d5e6f7g8h9i0j1k2"}}},{"connectionType":"STS_VAULT_SECRET","id":"mcn2b3c4d5e6f7g8h9i0","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn2b3c4d5e6f7g8h9i0","status":"ACTIVE","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"AWS Access Key Secret","path":"/prod/aws-keys","description":"Production AWS API credentials","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn2b3c4d5e6f7g8h9i0"}}},{"connectionType":"STS_SERVICE_ACCOUNT","id":"mcn3c4d5e6f7g8h9i0j1","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn3c4d5e6f7g8h9i0j1","status":"INACTIVE","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa5rb5mt2H3d1TJd0h7","name":"Slack Enterprise","logo":"https://example.com/img/logos/slack.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/admin/app/slack/instance/0oa5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/app/slack/instance/0oa5rb5mt2H3d1TJd0h7","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Slack Notification Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn3c4d5e6f7g8h9i0j1"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections"}}},"summary":"List all AI agent connections"},"components/examples/list-agent-connections-filtered-by-a2a-server-example":{"id":"components/examples/list-agent-connections-filtered-by-a2a-server-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections?filter=resource.orn%20eq%20%22orn%3Aokta%3Adirectory%3A00o1n8sbwArJ7OQRw406%3Aresource-servers%3Aa2a%3Awlpkhjm0jnDp8RrUu0g4%22"}}},"summary":"List connections filtered by A2A server (URL-encoded filter)"},"components/examples/list-agent-connections-filtered-by-virtual-mcp-server-example":{"id":"components/examples/list-agent-connections-filtered-by-virtual-mcp-server-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections?filter=resource.orn%20eq%20%22orn%3Aokta%3Adirectory%3A00o1gjjp4jsdR3Sww4x7%3Aresource-servers%3Avirtual-mcp%3Awlp1aB2cD3eF4gH5iJ6k%22"}}},"summary":"List connections filtered by virtual MCP server (URL-encoded filter)"},"components/examples/list-agent-connections-with-a2a-server-example":{"id":"components/examples/list-agent-connections-with-a2a-server-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections"}}},"summary":"List all AI agent connections (including A2A server connections)"},"components/examples/list-agent-connections-with-virtual-mcp-server-example":{"id":"components/examples/list-agent-connections-with-virtual-mcp-server-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections"}}},"summary":"List all AI agent connections (including virtual MCP server connections)"},"components/examples/list-delegation-links-agent-metadata-response":{"id":"components/examples/list-delegation-links-agent-metadata-response","value":{"data":[{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"agentMetadata":{"name":"Sales Agent"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=agentMetadata"}}},"summary":"List all delegation links with `expand=agentMetadata`"},"components/examples/list-delegation-links-app-metadata-response":{"id":"components/examples/list-delegation-links-app-metadata-response","value":{"data":[{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"},"_embedded":{"appMetadata":{"clientName":"My OIDC App","applicationType":"web","grantTypes":["authorization_code","refresh_token"]}}},{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"appMetadata":{"clientName":"My OIDC App","applicationType":"web","grantTypes":["authorization_code","refresh_token"]}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=appMetadata"}}},"summary":"List all delegation links with `expand=appMetadata`"},"components/examples/list-delegation-links-custom-authorization-server-metadata-response":{"id":"components/examples/list-delegation-links-custom-authorization-server-metadata-response","value":{"data":[{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"customAuthorizationServerMetadata":{"name":"My Custom Authorization Server","issuer":"https://example.okta.com/oauth2/aus1gjh63g214q0Hq0g4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=customAuthorizationServerMetadata"}}},"summary":"List all delegation links with `expand=customAuthorizationServerMetadata`"},"components/examples/list-delegation-links-expanded-response":{"id":"components/examples/list-delegation-links-expanded-response","value":{"data":[{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"appMetadata":{"clientName":"My OIDC App","applicationType":"web","grantTypes":["authorization_code","refresh_token"]},"customAuthorizationServerMetadata":{"name":"My Custom Authorization Server","issuer":"https://example.okta.com/oauth2/aus1gjh63g214q0Hq0g4"}}},{"id":"dlk3c4d5e6f7g8h9i0j1","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"agentMetadata":{"name":"Sales Agent"},"customAuthorizationServerMetadata":{"name":"My Custom Authorization Server","issuer":"https://example.okta.com/oauth2/aus1gjh63g214q0Hq0g4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata"}}},"summary":"List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`"},"components/examples/list-delegation-links-response":{"id":"components/examples/list-delegation-links-response","value":{"data":[{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links"}}},"summary":"List all delegation links"},"components/examples/list-potential-connections-a2a-server-example":{"id":"components/examples/list-potential-connections-a2a-server-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22IDENTITY_ASSERTION_A2A_SERVER%22"}}},"summary":"List all IDENTITY_ASSERTION_A2A_SERVER potential connections"},"components/examples/list-potential-connections-custom-as-example":{"id":"components/examples/list-potential-connections-custom-as-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server for CRM API","issuerUrl":"https://{yourOktaDomain}/oauth2/aus3m4n5k6l7p8q9r0s1","logo":"https://example.com/img/logos/custom-as.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22IDENTITY_ASSERTION_CUSTOM_AS%22"}}},"summary":"List all IDENTITY_ASSERTION_CUSTOM_AS potential connections"},"components/examples/list-potential-connections-service-account-example":{"id":"components/examples/list-potential-connections-service-account-example","value":{"data":[{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4","name":"Slack Enterprise","logo":"https://example.com/img/logos/slack.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/slack/instance/0oa1gjh63g214q0Hq0g4","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Slack Notification Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}}},{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:jira:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:jira:0oa5rb5mt2H3d1TJd0h7","name":"Jira Cloud","logo":"https://example.com/img/logos/jira.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/app/jira/instance/0oa5rb5mt2H3d1TJd0h7","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:jira:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Jira Automation Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}}},{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:github:0oa2c8xwvBn4h2Ry50g7:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa2c8xwvBn4h2Ry50g7","name":"GitHub Enterprise","logo":"https://example.com/img/logos/github.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa2c8xwvBn4h2Ry50g7","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:github:0oa2c8xwvBn4h2Ry50g7:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"GitHub Actions Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_SERVICE_ACCOUNT%22"}}},"summary":"List all STS_SERVICE_ACCOUNT potential connections"},"components/examples/list-potential-connections-sts-access-token-api-server-example":{"id":"components/examples/list-potential-connections-sts-access-token-api-server-example","value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","resourceIndicator":"https://api.stripe.com","resource":{"resourceType":"API_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:api:api8nUa7p0g4zrZbs2f4","name":"Stripe API","apiServerId":"api8nUa7p0g4zrZbs2f4","resourceUrl":"https://api.stripe.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Stripe API OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/api-servers/api8nUa7p0g4zrZbs2f4"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_ACCESS_TOKEN%22%20and%20resourceType%20eq%20%22API_SERVER%22"}}},"summary":"List STS access token potential connections for API Servers"},"components/examples/list-potential-connections-sts-access-token-example":{"id":"components/examples/list-potential-connections-sts-access-token-example","value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","resource":{"resourceType":"APP_INSTANCE","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa1gjh63g214q0Hq0g4","logo":"https://example.com/img/logos/github.png","appInstanceId":"0oa1gjh63g214q0Hq0g4","appInstanceName":"GitHub Enterprise","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","name":"GitHub Enterprise OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc1gjh63g214q0Hq0g4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa1gjh63g214q0Hq0g4#tab-resource-server","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_ACCESS_TOKEN%22"}}},"summary":"List all STS_ACCESS_TOKEN potential connections"},"components/examples/list-potential-connections-sts-access-token-mcp-server-example":{"id":"components/examples/list-potential-connections-sts-access-token-mcp-server-example","value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_ACCESS_TOKEN%22%20and%20resourceType%20eq%20%22MCP_SERVER%22"}}},"summary":"List STS_ACCESS_TOKEN potential connections for MCP servers"},"components/examples/list-potential-connections-vaulted-secret-example":{"id":"components/examples/list-potential-connections-vaulted-secret-example","value":{"data":[{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"AWS Production API Key","path":"/secrets/aws/prod-api-key","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}}},{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b","name":"Azure Service Principal Secret","path":"/secrets/azure/service-principal","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b","type":"text/html"}}}},{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c","name":"Database Connection String","path":"/secrets/database/prod-connection","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_VAULT_SECRET%22"}}},"summary":"List all STS_VAULT_SECRET potential connections"},"components/examples/list-potential-connections-virtual-mcp-server-example":{"id":"components/examples/list-potential-connections-virtual-mcp-server-example","value":{"data":[{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER%22"}}},"summary":"List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections"},"components/examples/list-virtual-mcp-connection-capabilities-example":{"id":"components/examples/list-virtual-mcp-connection-capabilities-example","value":{"data":[{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"}},{"id":"vsc7lM8nO9pQ0rS1tU2v","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt7lM8nO9pQ0rS1tU2v","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"INVALID","profile":{"name":"list_issues","description":"List issues from a repository","alias":"list_issues"}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k/capabilities?limit=20"},"next":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k/capabilities?after=vsc7lM8nO9pQ0rS1tU2v&limit=20"},"parent":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k"}}},"summary":"List of capabilities"},"components/examples/list-virtual-mcp-connection-capabilities-with-inputSchema-example":{"id":"components/examples/list-virtual-mcp-connection-capabilities-with-inputSchema-example","value":{"data":[{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"},"_embedded":{"inputSchema":{"type":"object","properties":{"repo":{"type":"string"},"state":{"type":"string","enum":["open","closed","all"]}}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k/capabilities?expand=inputSchema&limit=20"},"parent":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k"}}},"summary":"List of capabilities with inputSchema expanded"},"components/examples/list-virtual-mcp-connections-example":{"id":"components/examples/list-virtual-mcp-connections-example","value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"},"capabilities":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7/capabilities"}}},{"connectionType":"STS_ACCESS_TOKEN","id":"mcn8h9i0j1k2l3m4n5o6","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn8h9i0j1k2l3m4n5o6","status":"INACTIVE","resourceIndicator":"https://mcp.tools.internal.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp3d9ywCo5i3Sz61h8","name":"Internal Tools MCP Server","mcpServerId":"mcp3d9ywCo5i3Sz61h8","endpointUrl":"https://mcp.tools.internal.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Internal Tools OAuth Config","oauthConfiguration":{"scopes":["agents:read","agents:write"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp3d9ywCo5i3Sz61h8"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp3d9ywCo5i3Sz61h8","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn8h9i0j1k2l3m4n5o6"},"capabilities":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn8h9i0j1k2l3m4n5o6/capabilities"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections"}}},"summary":"List all virtual MCP connections"},"components/examples/listWorkloadPrincipalOperationsResponse":{"id":"components/examples/listWorkloadPrincipalOperationsResponse","value":{"data":[{"id":"op-1a2b3c4d","type":"ai-agent:Register","status":"COMPLETED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z","resource":{"id":"aiAgent_abc123def456","type":"ai_agent","status":"ACTIVE","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/ai-agents/aiAgent_abc123def456"}}}},{"id":"op-4e5f6g7h","type":"virtual-mcp:Register","status":"COMPLETED","created":"2025-09-11T20:00:00.000Z","started":"2025-09-11T20:00:01.000Z","completed":"2025-09-11T20:00:03.000Z","resource":{"id":"vmcp_xyz789abc012","type":"VIRTUAL_MCP","status":"ACTIVE","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/ai-agents/aiAgent_abc123def456"}}}},{"id":"op-0f1e2d3c","type":"ai-agent:Replace","status":"IN_PROGRESS","created":"2025-09-10T15:00:00.000Z","started":"2025-09-10T15:00:01.000Z"},{"id":"op-2b3c4d5e","type":"ai-agent:Delete","status":"FAILED","created":"2025-09-10T14:30:00.000Z","started":"2025-09-10T14:30:01.000Z","completed":"2025-09-10T14:30:05.000Z","errorDetails":{"code":"E0000001","message":"custom error message."}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/operations"},"next":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/operations?after=op-2b3c4d5e"}}},"summary":"List of workload principal operations"},"components/examples/patch-resource-connection-identity-assertion-example":{"id":"components/examples/patch-resource-connection-identity-assertion-example","value":{"scopeCondition":"INCLUDE_ONLY","scopes":["crm.contacts.read","crm.accounts.write","crm.reports.read"]},"summary":"Patch an identity assertion resource connection"},"components/examples/patch-resource-connection-identity-assertion-excluded-example":{"id":"components/examples/patch-resource-connection-identity-assertion-excluded-example","value":{"scopeCondition":"EXCLUDE","scopes":["crm.admin.delete","crm.admin.write"]},"summary":"Update an identity assertion resource connection with excluded scopes"},"components/examples/patch-resource-connection-issuer-url-a2a-server-example":{"id":"components/examples/patch-resource-connection-issuer-url-a2a-server-example","value":{"issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4"},"summary":"Update the issuer URL for an A2A server connection","description":"Update the issuerUrl for an A2A server connection."},"components/examples/patch-resource-connection-issuer-url-app-instance-example":{"id":"components/examples/patch-resource-connection-issuer-url-app-instance-example","value":{"issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4"},"summary":"Update the issuer URL for an app instance connection","description":"Update the issuerUrl for an app instance connection."},"components/examples/patch-resource-connection-issuer-url-example":{"id":"components/examples/patch-resource-connection-issuer-url-example","value":{"issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4"},"summary":"Update the issuer URL","description":"Update the issuerUrl for an identity assertion connection."},"components/examples/patch-resource-connection-reset-resource-indicator-example":{"id":"components/examples/patch-resource-connection-reset-resource-indicator-example","value":{"resourceIndicator":null},"summary":"Reset resource indicator to default","description":"Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN)."},"components/examples/patch-resource-connection-resource-indicator-example":{"id":"components/examples/patch-resource-connection-resource-indicator-example","value":{"resourceIndicator":"https://api.custom-domain.company.com"},"summary":"Update the resource indicator"},"components/examples/patch-resource-connection-response-example":{"id":"components/examples/patch-resource-connection-response-example","value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn1a2b3c4d5e6f7g8h9","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn1a2b3c4d5e6f7g8h9","status":"ACTIVE","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus1gjh63g214q0Hq0g4","name":"CRM Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus1gjh63g214q0Hq0g4","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.contacts.read","crm.accounts.write","crm.reports.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn1a2b3c4d5e6f7g8h9"}}},"summary":"Updated resource connection for a custom authorization server"},"components/examples/patch-virtual-mcp-connection-example":{"id":"components/examples/patch-virtual-mcp-connection-example","value":{"resourceIndicator":"https://mcp.custom-domain.company.com"},"summary":"Update the resource indicator"},"components/examples/patch-virtual-mcp-connection-reset-example":{"id":"components/examples/patch-virtual-mcp-connection-reset-example","value":{"resourceIndicator":null},"summary":"Reset resource indicator to default"},"components/examples/patch-virtual-mcp-connection-response-example":{"id":"components/examples/patch-virtual-mcp-connection-response-example","value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.custom-domain.company.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"summary":"Updated virtual MCP connection"},"components/examples/replace-virtual-mcp-connection-capabilities-example":{"id":"components/examples/replace-virtual-mcp-connection-capabilities-example","value":{"data":[{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","alias":"get_jira_issues"},{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt7lM8nO9pQ0rS1tU2v"}]},"summary":"Replace all capabilities"},"components/examples/update-virtual-mcp-connection-capability-example":{"id":"components/examples/update-virtual-mcp-connection-capability-example","value":{"alias":"get_jira_issues_v2"},"summary":"Update a capability alias"},"components/examples/virtual-mcp-connection-specific-capability-example":{"id":"components/examples/virtual-mcp-connection-specific-capability-example","value":{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"}},"summary":"Specific capability"},"components/examples/virtual-mcp-connection-specific-capability-with-inputSchema-example":{"id":"components/examples/virtual-mcp-connection-specific-capability-with-inputSchema-example","value":{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"},"_embedded":{"inputSchema":{"type":"object","properties":{"repo":{"type":"string"},"state":{"type":"string","enum":["open","closed","all"]}}}}},"summary":"Specific capability with inputSchema expanded"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_CUSTOM_AS potential connections":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server for CRM API","issuerUrl":"https://{yourOktaDomain}/oauth2/aus3m4n5k6l7p8q9r0s1","logo":"https://example.com/img/logos/custom-as.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22IDENTITY_ASSERTION_CUSTOM_AS%22"}}},"key":"List all IDENTITY_ASSERTION_CUSTOM_AS potential connections","summary":"List all IDENTITY_ASSERTION_CUSTOM_AS potential connections","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_CUSTOM_AS potential connections"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_VAULT_SECRET potential connections":{"value":{"data":[{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"AWS Production API Key","path":"/secrets/aws/prod-api-key","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}}},{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b","name":"Azure Service Principal Secret","path":"/secrets/azure/service-principal","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/f3759h79-eg61-5cb9-b9a9-7d1g93g8ae9b","type":"text/html"}}}},{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c","name":"Database Connection String","path":"/secrets/database/prod-connection","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/a4860i8a-fh72-6dca-caba-8e2ha4h9bf0c","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_VAULT_SECRET%22"}}},"key":"List all STS_VAULT_SECRET potential connections","summary":"List all STS_VAULT_SECRET potential connections","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_VAULT_SECRET potential connections"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_SERVICE_ACCOUNT potential connections":{"value":{"data":[{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4","name":"Slack Enterprise","logo":"https://example.com/img/logos/slack.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/slack/instance/0oa1gjh63g214q0Hq0g4","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Slack Notification Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}}},{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:jira:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:jira:0oa5rb5mt2H3d1TJd0h7","name":"Jira Cloud","logo":"https://example.com/img/logos/jira.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/app/jira/instance/0oa5rb5mt2H3d1TJd0h7","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:jira:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Jira Automation Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}}},{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:github:0oa2c8xwvBn4h2Ry50g7:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa2c8xwvBn4h2Ry50g7","name":"GitHub Enterprise","logo":"https://example.com/img/logos/github.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa2c8xwvBn4h2Ry50g7","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:github:0oa2c8xwvBn4h2Ry50g7:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"GitHub Actions Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_SERVICE_ACCOUNT%22"}}},"key":"List all STS_SERVICE_ACCOUNT potential connections","summary":"List all STS_SERVICE_ACCOUNT potential connections","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_SERVICE_ACCOUNT potential connections"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_ACCESS_TOKEN potential connections":{"value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","resource":{"resourceType":"APP_INSTANCE","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa1gjh63g214q0Hq0g4","logo":"https://example.com/img/logos/github.png","appInstanceId":"0oa1gjh63g214q0Hq0g4","appInstanceName":"GitHub Enterprise","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","name":"GitHub Enterprise OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc1gjh63g214q0Hq0g4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa1gjh63g214q0Hq0g4#tab-resource-server","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_ACCESS_TOKEN%22"}}},"key":"List all STS_ACCESS_TOKEN potential connections","summary":"List all STS_ACCESS_TOKEN potential connections","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all STS_ACCESS_TOKEN potential connections"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS_ACCESS_TOKEN potential connections for MCP servers":{"value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_ACCESS_TOKEN%22%20and%20resourceType%20eq%20%22MCP_SERVER%22"}}},"key":"List STS_ACCESS_TOKEN potential connections for MCP servers","summary":"List STS_ACCESS_TOKEN potential connections for MCP servers","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS_ACCESS_TOKEN potential connections for MCP servers"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS access token potential connections for API Servers":{"value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","resourceIndicator":"https://api.stripe.com","resource":{"resourceType":"API_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:api:api8nUa7p0g4zrZbs2f4","name":"Stripe API","apiServerId":"api8nUa7p0g4zrZbs2f4","resourceUrl":"https://api.stripe.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Stripe API OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/api-servers/api8nUa7p0g4zrZbs2f4"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22STS_ACCESS_TOKEN%22%20and%20resourceType%20eq%20%22API_SERVER%22"}}},"key":"List STS access token potential connections for API Servers","summary":"List STS access token potential connections for API Servers","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List STS access token potential connections for API Servers"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_A2A_SERVER potential connections":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22IDENTITY_ASSERTION_A2A_SERVER%22"}}},"key":"List all IDENTITY_ASSERTION_A2A_SERVER potential connections","summary":"List all IDENTITY_ASSERTION_A2A_SERVER potential connections","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_A2A_SERVER potential connections"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/potential-connections?filter=connectionType%20eq%20%22IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER%22"}}},"key":"List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections","summary":"List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/200/content/application~1json/examples/List all IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER potential connections"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/400/content/application~1json/examples/Missing Required Parameter":{"value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"sampleiCF-l7mr9XqM1NQ","errorCauses":[]},"key":"Missing Required Parameter","summary":"Missing Required Parameter","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/400/content/application~1json/examples/Missing Required Parameter"},"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1potential-connections/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn4d5e6f7g8h9i0j1k2","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn4d5e6f7g8h9i0j1k2","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7","authorizationServer":{"orn":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Auth Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.read","crm.write"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn4d5e6f7g8h9i0j1k2"}}},{"connectionType":"STS_VAULT_SECRET","id":"mcn2b3c4d5e6f7g8h9i0","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn2b3c4d5e6f7g8h9i0","status":"ACTIVE","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"AWS Access Key Secret","path":"/prod/aws-keys","description":"Production AWS API credentials","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn2b3c4d5e6f7g8h9i0"}}},{"connectionType":"STS_SERVICE_ACCOUNT","id":"mcn3c4d5e6f7g8h9i0j1","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn3c4d5e6f7g8h9i0j1","status":"INACTIVE","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa5rb5mt2H3d1TJd0h7","name":"Slack Enterprise","logo":"https://example.com/img/logos/slack.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/admin/app/slack/instance/0oa5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/app/slack/instance/0oa5rb5mt2H3d1TJd0h7","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa5rb5mt2H3d1TJd0h7:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Slack Notification Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn3c4d5e6f7g8h9i0j1"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections"}}},"key":"List all AI agent connections","summary":"List all AI agent connections","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including A2A server connections)":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections"}}},"key":"List all AI agent connections (including A2A server connections)","summary":"List all AI agent connections (including A2A server connections)","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including A2A server connections)"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by A2A server (URL-encoded filter)":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections?filter=resource.orn%20eq%20%22orn%3Aokta%3Adirectory%3A00o1n8sbwArJ7OQRw406%3Aresource-servers%3Aa2a%3Awlpkhjm0jnDp8RrUu0g4%22"}}},"key":"List connections filtered by A2A server (URL-encoded filter)","summary":"List connections filtered by A2A server (URL-encoded filter)","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by A2A server (URL-encoded filter)"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including virtual MCP server connections)":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections"}}},"key":"List all AI agent connections (including virtual MCP server connections)","summary":"List all AI agent connections (including virtual MCP server connections)","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List all AI agent connections (including virtual MCP server connections)"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by virtual MCP server (URL-encoded filter)":{"value":{"data":[{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections?filter=resource.orn%20eq%20%22orn%3Aokta%3Adirectory%3A00o1gjjp4jsdR3Sww4x7%3Aresource-servers%3Avirtual-mcp%3Awlp1aB2cD3eF4gH5iJ6k%22"}}},"key":"List connections filtered by virtual MCP server (URL-encoded filter)","summary":"List connections filtered by virtual MCP server (URL-encoded filter)","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/200/content/application~1json/examples/List connections filtered by virtual MCP server (URL-encoded filter)"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a custom authorization server":{"value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7"},"scopeCondition":"EXCLUDE","scopes":["crm.admin.delete","crm.admin.write"]},"key":"Create an identity assertion connection for a custom authorization server","summary":"Create an identity assertion connection for a custom authorization server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a custom authorization server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a vaulted secret connection":{"value":{"connectionType":"STS_VAULT_SECRET","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a"}},"key":"Create a vaulted secret connection","summary":"Create a vaulted secret connection","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a vaulted secret connection"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a service account connection":{"value":{"connectionType":"STS_SERVICE_ACCOUNT","resourceIndicator":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4"},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:slack:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861"}},"key":"Create a service account connection","summary":"Create a service account connection","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create a service account connection"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for an app instance":{"value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4"}},"key":"Create an STS access token connection for an app instance","summary":"Create an STS access token connection for an app instance","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for an app instance"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server":{"value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7"},"resourceIndicator":"https://mcp.example.com"},"key":"Create an STS access token connection for a third-party MCP server","summary":"Create an STS access token connection for a third-party MCP server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party API server":{"value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8"},"resourceIndicator":"https://api.stripe.com"},"key":"Create an STS access token connection for a third-party API server","summary":"Create an STS access token connection for a third-party API server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party API server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for an A2A server":{"value":{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4"},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7"},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"]},"key":"Create an identity assertion connection for an A2A server","summary":"Create an identity assertion connection for an A2A server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for an A2A server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a virtual MCP server":{"value":{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k"},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7"},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"]},"key":"Create an identity assertion connection for a virtual MCP server","summary":"Create an identity assertion connection for a virtual MCP server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/requestBody/content/application~1json/examples/Create an identity assertion connection for a virtual MCP server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A resource connection for a custom authorization server":{"value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn5e6f7g8h9i0j1k2l3","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn5e6f7g8h9i0j1k2l3","status":"INACTIVE","resourceIndicator":"https://api.custom-crm.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5t60iloOHN9pBi0h7","name":"Custom CRM Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5t60iloOHN9pBi0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5t60iloOHN9pBi0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5t60iloOHN9pBi0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.contacts.read","crm.accounts.write"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn5e6f7g8h9i0j1k2l3"}}},"key":"A resource connection for a custom authorization server","summary":"A resource connection for a custom authorization server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A resource connection for a custom authorization server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for an app instance":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn8h9i0j1k2l3m4n5o6","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn8h9i0j1k2l3m4n5o6","status":"INACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","resource":{"resourceType":"APP_INSTANCE","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa1gjh63g214q0Hq0g4","logo":"https://example.com/img/logos/github.png","appInstanceId":"0oa1gjh63g214q0Hq0g4","appInstanceName":"GitHub Enterprise","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","name":"GitHub Enterprise OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc1gjh63g214q0Hq0g4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa1gjh63g214q0Hq0g4#tab-resource-server","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn8h9i0j1k2l3m4n5o6"}}},"key":"A created STS access token resource connection for an app instance","summary":"A created STS access token resource connection for an app instance","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for an app instance"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party MCP server":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"A created STS access token resource connection for a third-party MCP server","summary":"A created STS access token resource connection for a third-party MCP server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party MCP server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party API server":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://api.stripe.com","resource":{"resourceType":"API_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:api:api8nUa7p0g4zrZbs2f4","name":"Stripe API","apiServerId":"api8nUa7p0g4zrZbs2f4","resourceUrl":"https://api.stripe.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Stripe API OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/api-servers/api8nUa7p0g4zrZbs2f4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"A created STS access token resource connection for a third-party API server","summary":"A created STS access token resource connection for a third-party API server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token resource connection for a third-party API server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for an A2A server":{"value":{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"INACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}},"key":"A created resource connection for an A2A server","summary":"A created resource connection for an A2A server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for an A2A server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for a virtual MCP server":{"value":{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"INACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}},"key":"A created resource connection for a virtual MCP server","summary":"A created resource connection for a virtual MCP server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/201/content/application~1json/examples/A created resource connection for a virtual MCP server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server":{"value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:crm:0oa1gjh63g214q0Hq0g4","authorizationServer":{"orn":"orn:okta:idp:00o5rb5mt2H3d1TJd0h7:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server for CRM API","issuerUrl":"https://{yourOktaDomain}/oauth2/aus3m4n5k6l7p8q9r0s1","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.read","crm.write"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}},"key":"Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server","summary":"Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server","description":"When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for custom authorization server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a custom authorization server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential":{"value":{"connectionType":"STS_SERVICE_ACCOUNT","id":"mcn3c4d5e6f7g8h9i0j1","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn3c4d5e6f7g8h9i0j1","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4","app":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4","name":"Test Org Custom SAML App","logo":"https://example.com/img/logos/custom-saml.png","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/admin/app/testorgone_customsaml20app_1/instance/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/testorgone_customsaml20app_1/instance/0oa1gjh63g214q0Hq0g4","type":"text/html"}}},"serviceAccount":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:apps:testorgone_customsaml20app_1:0oa1gjh63g214q0Hq0g4:service_accounts:4923897d-c665-488a-9480-a415b4080861","name":"Test Org SAML Bot","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/saas_app_accounts/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/saas_app_accounts/4923897d-c665-488a-9480-a415b4080861","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn3c4d5e6f7g8h9i0j1"}}},"key":"Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential","summary":"Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential","description":"When a resource connection enables a workload principal to obtain a service account credential","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a service account resource connection |tooltip| When a resource connection enables a workload principal to obtain a service account credential"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential":{"value":{"connectionType":"STS_VAULT_SECRET","id":"mcn2b3c4d5e6f7g8h9i0","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn2b3c4d5e6f7g8h9i0","status":"ACTIVE","resourceIndicator":"https://api.crm.company.com","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"Database Root Password","path":"/secrets/database/root-password","description":"Root password for production database server","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn2b3c4d5e6f7g8h9i0"}}},"key":"Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential","summary":"Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential","description":"When a resource connection enables a workload principal to obtain a vaulted secret credential","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get a vaulted secret resource connection |tooltip| When a resource connection enables a workload principal to obtain a vaulted secret credential"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn8h9i0j1k2l3m4n5o6","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn8h9i0j1k2l3m4n5o6","status":"ACTIVE","resourceIndicator":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","resource":{"resourceType":"APP_INSTANCE","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:apps:github:0oa1gjh63g214q0Hq0g4","logo":"https://example.com/img/logos/github.png","appInstanceId":"0oa1gjh63g214q0Hq0g4","appInstanceName":"GitHub Enterprise","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc1gjh63g214q0Hq0g4","name":"GitHub Enterprise OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc1gjh63g214q0Hq0g4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/apps/0oa1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/app/github/instance/0oa1gjh63g214q0Hq0g4#tab-resource-server","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn8h9i0j1k2l3m4n5o6"}}},"key":"Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings","summary":"Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings","description":"When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for an app instance |tooltip| When a resource connection enables OAuth-based token exchange for an app instance through client authentication settings"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings","summary":"Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings","description":"When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party MCP server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party MCP server through client authentication settings"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://api.stripe.com","resource":{"resourceType":"API_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:api:api8nUa7p0g4zrZbs2f4","name":"Stripe API","apiServerId":"api8nUa7p0g4zrZbs2f4","resourceUrl":"https://api.stripe.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Stripe API OAuth Config","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/api-servers/api8nUa7p0g4zrZbs2f4"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings","summary":"Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings","description":"When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token resource connection for a third-party API server |tooltip| When a resource connection enables OAuth-based token exchange for a third-party API server through client authentication settings"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server":{"value":{"connectionType":"IDENTITY_ASSERTION_A2A_SERVER","id":"mcn6f7g8h9i0j1k2l3m4","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn6f7g8h9i0j1k2l3m4","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:a2a:wlpkhjm0jnDp8RrUu0g4","name":"Code Assistant A2A Server","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpkhjm0jnDp8RrUu0g4"},"web":{"href":"https://{yourOktaDomain}/admin/directory/a2a-servers/wlpkhjm0jnDp8RrUu0g4","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["agent.invoke","agent.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn6f7g8h9i0j1k2l3m4"}}},"key":"Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server","summary":"Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server","description":"When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for an A2A server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for an A2A server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server":{"value":{"connectionType":"IDENTITY_ASSERTION_VIRTUAL_MCP_SERVER","id":"mcn7g8h9i0j1k2l3m4n5","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn7g8h9i0j1k2l3m4n5","status":"ACTIVE","resource":{"orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","name":"Production MCP Servers","_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"web":{"href":"https://{yourOktaDomain}/admin/access/agent-gateway/wlp1aB2cD3eF4gH5iJ6k","type":"text/html"}}},"authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus5rb5mt2H3d1TJd0h7","name":"Custom Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus5rb5mt2H3d1TJd0h7","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus5rb5mt2H3d1TJd0h7"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus5rb5mt2H3d1TJd0h7","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["mcp.invoke","mcp.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn7g8h9i0j1k2l3m4n5"}}},"key":"Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server","summary":"Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server","description":"When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an identity assertion resource connection for a virtual MCP server |tooltip| When a resource connection enables a workload principal to obtain an ID-JAG for a virtual MCP server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.":{"value":{"scopeCondition":"INCLUDE_ONLY","scopes":["crm.contacts.read","crm.accounts.write","crm.reports.read"]},"key":"Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","summary":"Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","description":"Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Patch an identity assertion resource connection |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types."},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.":{"value":{"scopeCondition":"EXCLUDE","scopes":["crm.admin.delete","crm.admin.write"]},"key":"Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","summary":"Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","description":"Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types.","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update an identity assertion resource connection with excluded scopes |tooltip| Update scopeCondition and scopes for an Identity Assertion connection. Only valid for IDENTITY_ASSERTION_CUSTOM_AS and IDENTITY_ASSERTION_A2A_SERVER types."},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).":{"value":{"resourceIndicator":"https://api.custom-domain.company.com"},"key":"Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","summary":"Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","description":"Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN).","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator |tooltip| Update only the resourceIndicator. Valid for all connection types except IDENTITY_ASSERTION_CUSTOM_AS (which uses the authorization server ORN)."},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).":{"value":{"resourceIndicator":null},"key":"Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","summary":"Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","description":"Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN).","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default |tooltip| Set resourceIndicator to null to reset it to the default value based on the connection type (app instance ORN, authorization server ORN, secret ORN, or service account ORN)."},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.":{"value":{"issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4"},"key":"Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.","summary":"Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection.","description":"Update the issuerUrl for an identity assertion connection.","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL |tooltip| Update the issuerUrl for an identity assertion connection."},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.":{"value":{"issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4"},"key":"Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.","summary":"Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection.","description":"Update the issuerUrl for an A2A server connection.","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an A2A server connection |tooltip| Update the issuerUrl for an A2A server connection."},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection.":{"value":{"issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4"},"key":"Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection.","summary":"Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection.","description":"Update the issuerUrl for an app instance connection.","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the issuer URL for an app instance connection |tooltip| Update the issuerUrl for an app instance connection."},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated resource connection for a custom authorization server":{"value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcn1a2b3c4d5e6f7g8h9","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn1a2b3c4d5e6f7g8h9","status":"ACTIVE","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus1gjh63g214q0Hq0g4","name":"CRM Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus1gjh63g214q0Hq0g4","type":"text/html"}}},"scopeCondition":"INCLUDE_ONLY","scopes":["crm.contacts.read","crm.accounts.write","crm.reports.read"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn1a2b3c4d5e6f7g8h9"}}},"key":"Updated resource connection for a custom authorization server","summary":"Updated resource connection for a custom authorization server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated resource connection for a custom authorization server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activate a resource connection for a custom authorization server":{"value":{"connectionType":"IDENTITY_ASSERTION_CUSTOM_AS","id":"mcnbcde12f3g4h5i6j7k","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcnbcde12f3g4h5i6j7k","status":"ACTIVE","resourceIndicator":"https://api.crm.company.com","authorizationServer":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:authorization_servers:aus1gjh63g214q0Hq0g4","name":"Custom CRM Authorization Server","issuerUrl":"https://{yourOktaDomain}/oauth2/aus1gjh63g214q0Hq0g4","_links":{"self":{"href":"https://{yourOktaDomain}/api/v1/authorizationServers/aus1gjh63g214q0Hq0g4"},"web":{"href":"https://{yourOktaDomain}/admin/oauth2/as/aus1gjh63g214q0Hq0g4","type":"text/html"}}},"scopeCondition":"ALL_SCOPES","scopes":["*"],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcnbcde12f3g4h5i6j7k"}}},"key":"Activate a resource connection for a custom authorization server","summary":"Activate a resource connection for a custom authorization server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activate a resource connection for a custom authorization server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/A deactivated resource connection":{"value":{"connectionType":"STS_VAULT_SECRET","id":"mcn0j1k2l3m4n5o6p7q8","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn0j1k2l3m4n5o6p7q8","status":"INACTIVE","resourceIndicator":"https://api.crm.company.com","secret":{"orn":"orn:okta:pam:00o1n8sbwArJ7OQRw406:secrets:d2642f68-df50-4ba8-a898-6c0f82f89d8a","name":"Database Root Password","path":"/secrets/database/root-password","description":"Root password for production database server","_links":{"self":{"href":"https://{yourOktaDomain}.pam.okta.com/v1/teams/default/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secrets/d2642f68-df50-4ba8-a898-6c0f82f89d8a"},"web":{"href":"https://{yourOktaDomain}.pam.okta.com/t/default/secrets/resource_groups/1c2a1d99-9a20-4d83-b602-34c278ec5249/projects/20662d8c-2ece-4a89-97d8-c7b437fb5b23/secret/d2642f68-df50-4ba8-a898-6c0f82f89d8a","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpkhjm0jnDp8RrUu0g4/connections/mcn0j1k2l3m4n5o6p7q8"}}},"key":"A deactivated resource connection","summary":"A deactivated resource connection","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/A deactivated resource connection"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/200/content/application~1json/examples/JSON Web Key list response example":{"value":{"data":[{"id":"pks2f4zrZbs8nUa7p0g4","kid":"DRUFXGF9XbLnS9k-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrKuine49_CEVR4GPn.....zOrouIUCSMlRL0HU=","status":"INACTIVE","created":"2023-02-21T20:08:24.000Z","lastUpdated":"2023-02-21T20:08:24.000Z","_links":{"activate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/activate","hints":{"allow":["POST"]}},"delete":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4","hints":{"allow":["DELETE"]}}}},{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks"}}},"key":"JSON Web Key list response example","summary":"JSON Web Key list response example","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/200/content/application~1json/examples/JSON Web Key list response example"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/401/content/application~1json/examples/Invalid Token Provided":{"value":{"errorCode":"E0000011","errorSummary":"Invalid token provided","errorLink":"E0000011","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Invalid Token Provided","summary":"Invalid Token Provided","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/401/content/application~1json/examples/Invalid Token Provided"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody/content/application~1json/examples/RSA JSON Web Key request example":{"value":{"kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE"},"key":"RSA JSON Web Key request example","summary":"RSA JSON Web Key request example","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/requestBody/content/application~1json/examples/RSA JSON Web Key request example"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/201/content/application~1json/examples/RSA JSON Web Key example":{"value":{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}},"key":"RSA JSON Web Key example","summary":"RSA JSON Web Key example","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/201/content/application~1json/examples/RSA JSON Web Key example"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyNonUniqueKid":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"Each key should have a unique `kid` when adding multiple keys."}]},"key":"ErrorAgentJsonWebKeyNonUniqueKid","summary":"ErrorAgentJsonWebKeyNonUniqueKid","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyNonUniqueKid"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyDuplicateKid":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"All keys in the `jwks` must have a unique `kid`."}]},"key":"ErrorAgentJsonWebKeyDuplicateKid","summary":"ErrorAgentJsonWebKeyDuplicateKid","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyDuplicateKid"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyKidLengthTooShort":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"RSA key length in the `jwks` is less than 2048 bits for the given key."}]},"key":"ErrorAgentJsonWebKeyKidLengthTooShort","summary":"ErrorAgentJsonWebKeyKidLengthTooShort","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyKidLengthTooShort"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyTooManyKids":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't create a new key. You have reached the maximum number of keys allowed (50). To add another key, you must first delete an existing one."}]},"key":"ErrorAgentJsonWebKeyTooManyKids","summary":"ErrorAgentJsonWebKeyTooManyKids","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorAgentJsonWebKeyTooManyKids"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorOnlyOneActiveEncryptionKeyAllowed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"The client can have only one active encryption key in the `jwks`."}]},"key":"ErrorOnlyOneActiveEncryptionKeyAllowed","summary":"ErrorOnlyOneActiveEncryptionKeyAllowed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/400/content/application~1json/examples/ErrorOnlyOneActiveEncryptionKeyAllowed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/401/content/application~1json/examples/Invalid Token Provided":{"value":{"errorCode":"E0000011","errorSummary":"Invalid token provided","errorLink":"E0000011","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Invalid Token Provided","summary":"Invalid Token Provided","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/401/content/application~1json/examples/Invalid Token Provided"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/200/content/application~1json/examples/RSA JSON Web Key example":{"value":{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}},"key":"RSA JSON Web Key example","summary":"RSA JSON Web Key example","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/200/content/application~1json/examples/RSA JSON Web Key example"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/401/content/application~1json/examples/Invalid Token Provided":{"value":{"errorCode":"E0000011","errorSummary":"Invalid token provided","errorLink":"E0000011","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Invalid Token Provided","summary":"Invalid Token Provided","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/401/content/application~1json/examples/Invalid Token Provided"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/400/content/application~1json/examples/ErrorDeleteActiveJsonWebKey":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't delete an active JSON Web Key. Deactivate the key before deleting it."}]},"key":"ErrorDeleteActiveJsonWebKey","summary":"ErrorDeleteActiveJsonWebKey","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/400/content/application~1json/examples/ErrorDeleteActiveJsonWebKey"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/401/content/application~1json/examples/Invalid Token Provided":{"value":{"errorCode":"E0000011","errorSummary":"Invalid token provided","errorLink":"E0000011","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Invalid Token Provided","summary":"Invalid Token Provided","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/401/content/application~1json/examples/Invalid Token Provided"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/RSA JSON Web Key example":{"value":{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"ACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"deactivate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/deactivate","hints":{"allow":["POST"]}}}},"key":"RSA JSON Web Key example","summary":"RSA JSON Web Key example","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/RSA JSON Web Key example"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/401/content/application~1json/examples/Invalid Token Provided":{"value":{"errorCode":"E0000011","errorSummary":"Invalid token provided","errorLink":"E0000011","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Invalid Token Provided","summary":"Invalid Token Provided","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/401/content/application~1json/examples/Invalid Token Provided"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivate JSON Signing Key example":{"value":{"id":"pks2f50kZB0cITmYU0g4","kid":"ASHJHGasa782333-Sla3x3POBiIxDreBCdZuFs5B","kty":"RSA","alg":"RS256","use":"sig","e":"AQAB","n":"AJncrzOrouIUCSMlRL0HU.....Kuine49_CEVR4GPn=","status":"INACTIVE","created":"2023-04-06T21:32:33.000Z","lastUpdated":"2023-04-06T21:32:33.000Z","_links":{"activate":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3/credentials/jwks/pks2f4zrZbs8nUa7p0g4/lifecycle/activate","hints":{"allow":["POST"]}}}},"key":"Deactivate JSON Signing Key example","summary":"Deactivate JSON Signing Key example","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivate JSON Signing Key example"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"Can't deactivate the only active JSON Web Key when the value for `token_endpoint_auth_method` is `private_key_jwt`."}]},"key":"ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod","summary":"ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithPrivateKeyJwtAuthMethod"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"The `jwks` must contain at least one key with an algorithm matching the `request_object_signature_algorithm`."}]},"key":"ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm","summary":"ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateTheOnlyKeyWithRequestObjectSignAlgorithm"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateEncryptionKey":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: JsonWebKey","errorLink":"E0000001","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[{"errorSummary":"You can't deactivate the active encryption key."}]},"key":"ErrorDeactivateEncryptionKey","summary":"ErrorDeactivateEncryptionKey","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/ErrorDeactivateEncryptionKey"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/401/content/application~1json/examples/Invalid Token Provided":{"value":{"errorCode":"E0000011","errorSummary":"Invalid token provided","errorLink":"E0000011","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Invalid Token Provided","summary":"Invalid Token Provided","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/401/content/application~1json/examples/Invalid Token Provided"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1credentials~1jwks~1{keyId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents":{"value":{"data":[{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?limit=1"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?after=wlpx9jQ16k9V8IFEL0&limit=1"}}},"key":"List of AI agents","summary":"List of AI agents","id":"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents"},"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with delegation links (appId deprecated)":{"value":{"data":[{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?limit=1"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?after=wlpx9jQ16k9V8IFEL0&limit=1"}}},"key":"List of AI agents with delegation links (appId deprecated)","summary":"List of AI agents with delegation links (appId deprecated)","id":"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with delegation links (appId deprecated)"},"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with sign-on provider state":{"value":{"data":[{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Demo Agent","description":"Demo Agent"},"oauthClient":{"clientId":"wlpx9jQ16k9V8IFEL0g3"},"signOnProvider":{"appInstanceId":"0oaNewApp4561a2b3c4d"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}},{"id":"wlpx8kR27j0U7HGDM1h4","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Orchestrator Agent","description":"Orchestrator Agent"},"oauthClient":{"clientId":"0oaExistingApp123"},"signOnProvider":{"appInstanceId":"0oaExistingApp123"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx8kR27j0U7HGDM1h4","method":"GET"}}}],"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?limit=2"},"next":{"rel":"next","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents?after=wlpx8kR27j0U7HGDM1h4&limit=2"}}},"key":"List of AI agents with sign-on provider state","summary":"List of AI agents with sign-on provider state","id":"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/200/content/application~1json/examples/List of AI agents with sign-on provider state"},"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent without an A2A server":{"value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Orchestrator Agent","description":"Orchestrator AI Agent"}},"key":"Create an AI agent without an A2A server","summary":"Create an AI agent without an A2A server","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent without an A2A server"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with an A2A server":{"value":{"appId":"0oab1234EXAMPLEID5d6","resourceUrl":"https://demo-agent.example.com","profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"}},"key":"Create an AI agent with an A2A server","summary":"Create an AI agent with an A2A server","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with an A2A server"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to a new OIDC app instance":{"value":{"profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"},"signOnProvider":{"type":"NEW_OIDC_APP"}},"key":"Create an AI agent and bind it to a new OIDC app instance","summary":"Create an AI agent and bind it to a new OIDC app instance","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to a new OIDC app instance"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to an existing app instance":{"value":{"profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"},"signOnProvider":{"type":"EXISTING_APP","appInstanceId":"0oaExistingApp123"}},"key":"Create an AI agent and bind it to an existing app instance","summary":"Create an AI agent and bind it to an existing app instance","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent and bind it to an existing app instance"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with a CIMD OAuth client":{"value":{"profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"},"oauthClient":{"type":"CIMD","clientIdMatchPattern":"https://agent.example.com/metadata.json"}},"key":"Create an AI agent with a CIMD OAuth client","summary":"Create an AI agent with a CIMD OAuth client","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/requestBody/content/application~1json/examples/Create an AI agent with a CIMD OAuth client"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent without an A2A server":{"value":{"id":"wlpx8kR27j0U7HGDM1h4","externalId":"7TTZGRL8PV","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","platform":"OKTA","profile":{"name":"Orchestrator Agent","description":"Orchestrator Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx8kR27j0U7HGDM1h4","method":"GET"},"providers":[{"rel":"provider","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d","method":"GET"}]}},"key":"AI agent without an A2A server","summary":"AI agent without an A2A server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent without an A2A server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with staged status":{"value":{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"STAGED","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}},"key":"AI agent with staged status","summary":"AI agent with staged status","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with staged status"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with an A2A server":{"value":{"id":"wlpx9jQ16k9V8IFEL0g3","externalId":"3SSZFQL7OU","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","appId":"0oab1234EXAMPLEID5d6","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"},"providers":[{"rel":"provider","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d","method":"GET"},{"rel":"provider","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-4e5f6g7h","method":"GET"}]}},"key":"AI agent with an A2A server","summary":"AI agent with an A2A server","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with an A2A server"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with delegation links (appId deprecated)":{"value":{"id":"wlpx9jQ16k9V8IFEL0g3","externalId":"3SSZFQL7OU","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","platform":"OKTA","profile":{"name":"Demo Agent","description":"Demo Agent"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"resourceServer":{"rel":"resourceServer","href":"https://{yourOktaDomain}/resource-servers/api/v1/a2a-servers/wlpx9jQ16k9V8IFEL0g3","method":"GET"},"delegationLinks":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?filter=to.resourceOrn%20eq%20%22orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlpx9jQ16k9V8IFEL0g3%22"}}},"key":"AI agent with delegation links (appId deprecated)","summary":"AI agent with delegation links (appId deprecated)","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with delegation links (appId deprecated)"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with bound sign-on provider":{"value":{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"ACTIVE","profile":{"name":"Demo Agent","description":"Demo Agent"},"oauthClient":{"clientId":"wlpx9jQ16k9V8IFEL0g3"},"signOnProvider":{"appInstanceId":"0oaNewApp4561a2b3c4d"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}},"key":"AI agent with bound sign-on provider","summary":"AI agent with bound sign-on provider","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent with bound sign-on provider"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent registered with a CIMD OAuth client":{"value":{"id":"wlpx9jQ16k9V8IFEL0g3","created":"2022-04-04T15:56:05.000Z","lastUpdated":"2022-05-05T18:15:44.000Z","status":"STAGED","profile":{"name":"Demo Agent","description":"Demo Agent"},"oauthClient":{"clientId":"https://agent.example.com/metadata.json"},"_links":{"self":{"rel":"self","href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agents/wlpx9jQ16k9V8IFEL0g3","method":"GET"}}},"key":"AI agent registered with a CIMD OAuth client","summary":"AI agent registered with a CIMD OAuth client","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/200/content/application~1json/examples/AI agent registered with a CIMD OAuth client"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody/content/application~1json/examples/Replaces an ai-agent":{"value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Demo Agent","description":"Demo Conversational AI Agent"}},"key":"Replaces an ai-agent","summary":"Replaces an ai-agent","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/requestBody/content/application~1json/examples/Replaces an ai-agent"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/put/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId, name, and description":{"value":{"appId":"0oab1234EXAMPLEID5d6","profile":{"name":"Updated name","description":"Updated description"}},"key":"Update appId, name, and description","summary":"Update appId, name, and description","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId, name, and description"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update name only":{"value":{"profile":{"name":"Updated name only"}},"key":"Update name only","summary":"Update name only","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update name only"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId only":{"value":{"appId":"0oab1234EXAMPLEID5d6"},"key":"Update appId only","summary":"Update appId only","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update appId only"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Remove appId and description (set to null)":{"value":{"appId":null,"profile":{"description":null}},"key":"Remove appId and description (set to null)","summary":"Remove appId and description (set to null)","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Remove appId and description (set to null)"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update resourceUrl to associate an A2A server with the agent":{"value":{"resourceUrl":"https://demo-agent.example.com"},"key":"Update resourceUrl to associate an A2A server with the agent","summary":"Update resourceUrl to associate an A2A server with the agent","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Update resourceUrl to associate an A2A server with the agent"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to a new OIDC app instance":{"value":{"signOnProvider":{"type":"NEW_OIDC_APP"}},"key":"Bind an existing AI agent to a new OIDC app instance","summary":"Bind an existing AI agent to a new OIDC app instance","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to a new OIDC app instance"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to an existing app instance":{"value":{"signOnProvider":{"type":"EXISTING_APP","appInstanceId":"0oaExistingApp123"}},"key":"Bind an existing AI agent to an existing app instance","summary":"Bind an existing AI agent to an existing app instance","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/requestBody/content/application~1merge-patch+json/examples/Bind an existing AI agent to an existing app instance"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/patch/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agents~1{agentId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1operations/get/responses/200/content/application~1json/examples/List of workload principal operations":{"value":{"data":[{"id":"op-1a2b3c4d","type":"ai-agent:Register","status":"COMPLETED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z","resource":{"id":"aiAgent_abc123def456","type":"ai_agent","status":"ACTIVE","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/ai-agents/aiAgent_abc123def456"}}}},{"id":"op-4e5f6g7h","type":"virtual-mcp:Register","status":"COMPLETED","created":"2025-09-11T20:00:00.000Z","started":"2025-09-11T20:00:01.000Z","completed":"2025-09-11T20:00:03.000Z","resource":{"id":"vmcp_xyz789abc012","type":"VIRTUAL_MCP","status":"ACTIVE","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/ai-agents/aiAgent_abc123def456"}}}},{"id":"op-0f1e2d3c","type":"ai-agent:Replace","status":"IN_PROGRESS","created":"2025-09-10T15:00:00.000Z","started":"2025-09-10T15:00:01.000Z"},{"id":"op-2b3c4d5e","type":"ai-agent:Delete","status":"FAILED","created":"2025-09-10T14:30:00.000Z","started":"2025-09-10T14:30:01.000Z","completed":"2025-09-10T14:30:05.000Z","errorDetails":{"code":"E0000001","message":"custom error message."}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/operations"},"next":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/operations?after=op-2b3c4d5e"}}},"key":"List of workload principal operations","summary":"List of workload principal operations","id":"paths/~1workload-principals~1api~1v1~1operations/get/responses/200/content/application~1json/examples/List of workload principal operations"},"paths/~1workload-principals~1api~1v1~1operations/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1operations/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1operations/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1operations/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1operations/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1operations/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1operations/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1operations/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent operation response":{"value":{"id":"op-1a2b3c4d","type":"ai-agent:Register","status":"COMPLETED","created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z","resource":{"id":"aiAgent_abc123def456","type":"ai_agent","status":"ACTIVE","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principal/api/v1/ai-agents/aiAgent_abc123def456"}}}},"key":"Completed AI agent operation response","summary":"Completed AI agent operation response","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent operation response"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/In-progress AI agent operation response":{"value":{"id":"op-0f1e2d3c","type":"ai-agent:Replace","status":"IN_PROGRESS","created":"2025-09-10T15:00:00.000Z","started":"2025-09-10T15:00:01.000Z"},"key":"In-progress AI agent operation response","summary":"In-progress AI agent operation response","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/In-progress AI agent operation response"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Failed AI agent operation response":{"value":{"id":"op-2b3c4d5e","type":"ai-agent:Delete","status":"FAILED","created":"2025-09-10T14:30:00.000Z","started":"2025-09-10T14:30:01.000Z","completed":"2025-09-10T14:30:05.000Z","errorDetails":{"code":"E0000001","message":"custom error message."}},"key":"Failed AI agent operation response","summary":"Failed AI agent operation response","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Failed AI agent operation response"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent import operation response":{"value":{"id":"op-1a2b3c5d","type":"ai-agent:Import","status":"COMPLETED","operationMetadata":{"sourceName":"SALESFORCE","sourceId":"0oa3omz2i9XRNSRIHBZO","importProgress":{"scanned":2,"added":1,"removed":1,"changed":0,"unchanged":0}},"created":"2025-09-11T18:52:48.000Z","started":"2025-09-11T18:52:48.000Z","completed":"2025-09-11T18:52:49.000Z"},"key":"Completed AI agent import operation response","summary":"Completed AI agent import operation response","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed AI agent import operation response"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed virtual MCP operation response":{"value":{"id":"op-4e5f6g7h","type":"virtual-mcp:Register","status":"COMPLETED","created":"2025-09-12T10:00:00.000Z","started":"2025-09-12T10:00:01.000Z","completed":"2025-09-12T10:00:03.000Z","resource":{"id":"vmcp_xyz789abc012","type":"ai_agent","status":"ACTIVE","_links":{"self":{"href":"https://subdomain.okta.com/workload-principal/api/v1/virtual-mcp-servers/vmcp_xyz789abc012"}}}},"key":"Completed virtual MCP operation response","summary":"Completed virtual MCP operation response","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Completed virtual MCP operation response"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/200/content/application~1json/examples/A list of active AI agent providers":{"value":{"data":[{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/id"}}},{"id":"id2","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASK","sourceId":"appId2","sourceName":"Salesforce","sourceType":"apps","status":"INACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"groupOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:0og10sfroCwbHQO4a0g4"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/id2"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers"}}},"key":"A list of active AI agent providers","summary":"A list of active AI agent providers","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/200/content/application~1json/examples/A list of active AI agent providers"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider":{"value":{"sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]}},"key":"A request to create a new AI agent provider","summary":"A request to create a new AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider with a schedule":{"value":{"sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]}},"key":"A request to create a new AI agent provider with a schedule","summary":"A request to create a new AI agent provider with a schedule","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/requestBody/content/application~1json/examples/A request to create a new AI agent provider with a schedule"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"A created AI agent provider","summary":"A created AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider with a schedule":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","nextScheduledImportDate":"2024-07-01T12:00:00Z","schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"A created AI agent provider with a schedule","summary":"A created AI agent provider with a schedule","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/201/content/application~1json/examples/A created AI agent provider with a schedule"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody/content/application~1json/examples/A request to validate an AI agent provider":{"value":{"sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","configuration":{"clientId":"clientId","clientSecret":"clientSecret"}},"key":"A request to validate an AI agent provider","summary":"A request to validate an AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/requestBody/content/application~1json/examples/A request to validate an AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1validate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"An active AI agent provider","summary":"An active AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider with a schedule":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","nextScheduledImportDate":"2024-07-01T12:00:00Z","schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"An active AI agent provider with a schedule","summary":"An active AI agent provider with a schedule","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/200/content/application~1json/examples/An active AI agent provider with a schedule"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider":{"value":{"configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"key":"A request to replace an existing AI agent provider","summary":"A request to replace an existing AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider with a schedule":{"value":{"configuration":{"clientId":"clientId","clientSecret":"clientSecret"},"schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"key":"A request to replace an existing AI agent provider with a schedule","summary":"A request to replace an existing AI agent provider with a schedule","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/requestBody/content/application~1json/examples/A request to replace an existing AI agent provider with a schedule"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"A created AI agent provider","summary":"A created AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider with a schedule":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","nextScheduledImportDate":"2024-07-01T12:00:00Z","schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"A created AI agent provider with a schedule","summary":"A created AI agent provider with a schedule","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/put/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider":{"value":{"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"]}},"key":"A request to update an existing AI agent provider","summary":"A request to update an existing AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider with a schedule":{"value":{"schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"}},"key":"A request to update an existing AI agent provider with a schedule","summary":"A request to update an existing AI agent provider with a schedule","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/requestBody/content/application~1merge-patch+json/examples/A request to update an existing AI agent provider with a schedule"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"A created AI agent provider","summary":"A created AI agent provider","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider with a schedule":{"value":{"id":"id","sourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","sourceId":"appId","sourceName":"Salesforce","sourceType":"apps","status":"ACTIVE","integrationDate":"2024-01-01T12:00:00Z","lastImportDate":"2024-06-01T12:00:00Z","nextScheduledImportDate":"2024-07-01T12:00:00Z","schedule":{"cron":"0 0 9 ? * MON","timezone":"America/Los_Angeles"},"owners":{"userOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g5"]},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/ai-agent-providers/aip-1a2b3c4d"}}},"key":"A created AI agent provider with a schedule","summary":"A created AI agent provider with a schedule","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/200/content/application~1json/examples/A created AI agent provider with a schedule"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1import/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1ai-agent-providers~1{providerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links":{"value":{"data":[{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links"}}},"key":"List all delegation links","summary":"List all delegation links","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata`":{"value":{"data":[{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"},"_embedded":{"appMetadata":{"clientName":"My OIDC App","applicationType":"web","grantTypes":["authorization_code","refresh_token"]}}},{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"appMetadata":{"clientName":"My OIDC App","applicationType":"web","grantTypes":["authorization_code","refresh_token"]}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=appMetadata"}}},"key":"List all delegation links with `expand=appMetadata`","summary":"List all delegation links with `expand=appMetadata`","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata`"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=agentMetadata`":{"value":{"data":[{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"agentMetadata":{"name":"Sales Agent"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=agentMetadata"}}},"key":"List all delegation links with `expand=agentMetadata`","summary":"List all delegation links with `expand=agentMetadata`","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=agentMetadata`"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=customAuthorizationServerMetadata`":{"value":{"data":[{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"customAuthorizationServerMetadata":{"name":"My Custom Authorization Server","issuer":"https://example.okta.com/oauth2/aus1gjh63g214q0Hq0g4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=customAuthorizationServerMetadata"}}},"key":"List all delegation links with `expand=customAuthorizationServerMetadata`","summary":"List all delegation links with `expand=customAuthorizationServerMetadata`","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=customAuthorizationServerMetadata`"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`":{"value":{"data":[{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"appMetadata":{"clientName":"My OIDC App","applicationType":"web","grantTypes":["authorization_code","refresh_token"]},"customAuthorizationServerMetadata":{"name":"My Custom Authorization Server","issuer":"https://example.okta.com/oauth2/aus1gjh63g214q0Hq0g4"}}},{"id":"dlk3c4d5e6f7g8h9i0j1","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_embedded":{"agentMetadata":{"name":"Sales Agent"},"customAuthorizationServerMetadata":{"name":"My Custom Authorization Server","issuer":"https://example.okta.com/oauth2/aus1gjh63g214q0Hq0g4"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links?expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata"}}},"key":"List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`","summary":"List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/200/content/application~1json/examples/List all delegation links with `expand=appMetadata&expand=agentMetadata&expand=customAuthorizationServerMetadata`"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1delegation-links/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an ID token":{"value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"key":"Link that allows the app to delegate to an AI agent with an ID token","summary":"Link that allows the app to delegate to an AI agent with an ID token","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an ID token"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an access token":{"value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"key":"Link that allows the app to delegate to an AI agent with an access token","summary":"Link that allows the app to delegate to an AI agent with an access token","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows the app to delegate to an AI agent with an access token"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an AI agent to delegate to another AI agent with an access token":{"value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"key":"Link that allows an AI agent to delegate to another AI agent with an access token","summary":"Link that allows an AI agent to delegate to another AI agent with an access token","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an AI agent to delegate to another AI agent with an access token"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an app to delegate to a virtual MCP server with an access token":{"value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:virtual-mcp:vms1aB2cD3eF4gH5iJ6k"}},"key":"Link that allows an app to delegate to a virtual MCP server with an access token","summary":"Link that allows an app to delegate to a virtual MCP server with an access token","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Link that allows an app to delegate to a virtual MCP server with an access token"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field":{"value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"}},"key":"Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field","summary":"Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field","description":"Creates a delegation link with only the resourceOrn field","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/Minimal delegation link with only required fields |tooltip| Creates a delegation link with only the resourceOrn field"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server":{"value":{"from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"}},"key":"The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server","summary":"The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server","description":"Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/requestBody/content/application~1json/examples/The `ID_TOKEN` delegation link specifying a custom authorization server |tooltip| Creates an `ID_TOKEN` delegation link with `authorizationServerOrn` to use a custom authorization server instead of the default org authorization server"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/201/content/application~1json/examples/A created delegation link":{"value":{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links/dlk1a2b3c4d5e6f7g8h9"}}},"key":"A created delegation link","summary":"A created delegation link","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/201/content/application~1json/examples/A created delegation link"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1delegation-links/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent":{"value":{"id":"dlk1a2b3c4d5e6f7g8h9","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc_client:0oafxqCAJWWGELFTYASJ","tokenType":"ID_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp25spbxqmZzyS4f0h8"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links/dlk1a2b3c4d5e6f7g8h9"}}},"key":"Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent","summary":"Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent","description":"Retrieves a delegation link from an app to an AI agent","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an app as the source |tooltip| Retrieves a delegation link from an app to an AI agent"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent":{"value":{"id":"dlk2b3c4d5e6f7g8h9i0","from":{"type":"OKTA_AUTHORIZATION_SERVER","clientOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp19kc5yr3UTqS8o2p8","tokenType":"ACCESS_TOKEN"},"to":{"resourceOrn":"orn:okta:directory:00o4p0z0f8s5rNkEJ8g6:workload-principals:ai-agents:wlp1j8yjr17pp6l8V0x8","authorizationServerOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:authorization_servers:aus1gjh63g214q0Hq0g4"},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/delegation-links/dlk2b3c4d5e6f7g8h9i0"}}},"key":"Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent","summary":"Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent","description":"Retrieves a delegation link from an AI agent to another AI agent","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/200/content/application~1json/examples/Retrieve a delegation link with an AI agent as the source |tooltip| Retrieves a delegation link from an AI agent to another AI agent"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1delegation-links~1{delegationLinkId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/200/content/application~1json/examples/List all virtual MCP connections":{"value":{"data":[{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"},"capabilities":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7/capabilities"}}},{"connectionType":"STS_ACCESS_TOKEN","id":"mcn8h9i0j1k2l3m4n5o6","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn8h9i0j1k2l3m4n5o6","status":"INACTIVE","resourceIndicator":"https://mcp.tools.internal.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp3d9ywCo5i3Sz61h8","name":"Internal Tools MCP Server","mcpServerId":"mcp3d9ywCo5i3Sz61h8","endpointUrl":"https://mcp.tools.internal.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc3d9ywCo5i3Sz61h8","name":"Internal Tools OAuth Config","oauthConfiguration":{"scopes":["agents:read","agents:write"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc3d9ywCo5i3Sz61h8"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp3d9ywCo5i3Sz61h8"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp3d9ywCo5i3Sz61h8","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn8h9i0j1k2l3m4n5o6"},"capabilities":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn8h9i0j1k2l3m4n5o6/capabilities"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections"}}},"key":"List all virtual MCP connections","summary":"List all virtual MCP connections","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/200/content/application~1json/examples/List all virtual MCP connections"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server":{"value":{"connectionType":"STS_ACCESS_TOKEN","resource":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7"},"resourceIndicator":"https://mcp.example.com"},"key":"Create an STS access token connection for a third-party MCP server","summary":"Create an STS access token connection for a third-party MCP server","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/requestBody/content/application~1json/examples/Create an STS access token connection for a third-party MCP server"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token connection for a third-party MCP server":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"A created STS access token connection for a third-party MCP server","summary":"A created STS access token connection for a third-party MCP server","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/201/content/application~1json/examples/A created STS access token connection for a third-party MCP server"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token connection for a third-party MCP server":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"Get an STS access token connection for a third-party MCP server","summary":"Get an STS access token connection for a third-party MCP server","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/200/content/application~1json/examples/Get an STS access token connection for a third-party MCP server"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator":{"value":{"resourceIndicator":"https://mcp.custom-domain.company.com"},"key":"Update the resource indicator","summary":"Update the resource indicator","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Update the resource indicator"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default":{"value":{"resourceIndicator":null},"key":"Reset resource indicator to default","summary":"Reset resource indicator to default","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/requestBody/content/application~1merge-patch+json/examples/Reset resource indicator to default"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated virtual MCP connection":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.custom-domain.company.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"Updated virtual MCP connection","summary":"Updated virtual MCP connection","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/200/content/application~1json/examples/Updated virtual MCP connection"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/patch/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities":{"value":{"data":[{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"}},{"id":"vsc7lM8nO9pQ0rS1tU2v","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt7lM8nO9pQ0rS1tU2v","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"INVALID","profile":{"name":"list_issues","description":"List issues from a repository","alias":"list_issues"}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k/capabilities?limit=20"},"next":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k/capabilities?after=vsc7lM8nO9pQ0rS1tU2v&limit=20"},"parent":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k"}}},"key":"List of capabilities","summary":"List of capabilities","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities with inputSchema expanded":{"value":{"data":[{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"},"_embedded":{"inputSchema":{"type":"object","properties":{"repo":{"type":"string"},"state":{"type":"string","enum":["open","closed","all"]}}}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k/capabilities?expand=inputSchema&limit=20"},"parent":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn1aB2cD3eF4gH5iJ6k"}}},"key":"List of capabilities with inputSchema expanded","summary":"List of capabilities with inputSchema expanded","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/200/content/application~1json/examples/List of capabilities with inputSchema expanded"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability with an alias":{"value":{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","alias":"get_jira_issues"},"key":"Add a capability with an alias","summary":"Add a capability with an alias","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability with an alias"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability without an alias":{"value":{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k"},"key":"Add a capability without an alias","summary":"Add a capability without an alias","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/requestBody/content/application~1json/examples/Add a capability without an alias"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/201/content/application~1json/examples/Specific capability":{"value":{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"}},"key":"Specific capability","summary":"Specific capability","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/201/content/application~1json/examples/Specific capability"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody/content/application~1json/examples/Replace all capabilities":{"value":{"data":[{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","alias":"get_jira_issues"},{"sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt7lM8nO9pQ0rS1tU2v"}]},"key":"Replace all capabilities","summary":"Replace all capabilities","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/requestBody/content/application~1json/examples/Replace all capabilities"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities/put/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability":{"value":{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"}},"key":"Specific capability","summary":"Specific capability","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability with inputSchema expanded":{"value":{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"},"_embedded":{"inputSchema":{"type":"object","properties":{"repo":{"type":"string"},"state":{"type":"string","enum":["open","closed","all"]}}}}},"key":"Specific capability with inputSchema expanded","summary":"Specific capability with inputSchema expanded","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/200/content/application~1json/examples/Specific capability with inputSchema expanded"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody/content/application~1json/examples/Update a capability alias":{"value":{"alias":"get_jira_issues_v2"},"key":"Update a capability alias","summary":"Update a capability alias","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/requestBody/content/application~1json/examples/Update a capability alias"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/200/content/application~1json/examples/Specific capability":{"value":{"id":"vsc1aB2cD3eF4gH5iJ6k","sourceOrn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:resource-servers:mcp:ems8nUa7p0g4zrZbs2f4:tools:emt1aB2cD3eF4gH5iJ6k","connectionOrn":"orn:okta:idp:00o1gjjp4jsdR3Sww4x7:connections:mcn1aB2cD3eF4gH5iJ6k","type":"TOOL","status":"VALID","profile":{"name":"get_issues","description":"Get issues from a repository","alias":"get_jira_issues"}},"key":"Specific capability","summary":"Specific capability","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/200/content/application~1json/examples/Specific capability"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/patch/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1capabilities~1{capabilityId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activated virtual MCP connection":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"ACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"Activated virtual MCP connection","summary":"Activated virtual MCP connection","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/200/content/application~1json/examples/Activated virtual MCP connection"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivated virtual MCP connection":{"value":{"connectionType":"STS_ACCESS_TOKEN","id":"mcn9i0j1k2l3m4n5o6p7","orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:connections:mcn9i0j1k2l3m4n5o6p7","status":"INACTIVE","resourceIndicator":"https://mcp.example.com","resource":{"resourceType":"MCP_SERVER","orn":"orn:okta:directory:00o1n8sbwArJ7OQRw406:resource-servers:mcp:mcp2c8xwvBn4h2Ry50g7","name":"Code Assistant MCP Server","mcpServerId":"mcp2c8xwvBn4h2Ry50g7","endpointUrl":"https://mcp.example.com","clientAuthSettings":{"orn":"orn:okta:idp:00o1n8sbwArJ7OQRw406:client_auth_settings:rsc2c8xwvBn4h2Ry50g7","name":"Code Assistant OAuth Config","oauthConfiguration":{"scopes":["tools:read","tools:execute","files:management"]},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/client-auth-settings/rsc2c8xwvBn4h2Ry50g7"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/mcp-servers/mcp2c8xwvBn4h2Ry50g7"},"web":{"href":"https://{yourOktaDomain}/admin/directory/mcp-servers/mcp2c8xwvBn4h2Ry50g7","type":"text/html"}}},"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k/connections/mcn9i0j1k2l3m4n5o6p7"}}},"key":"Deactivated virtual MCP connection","summary":"Deactivated virtual MCP connection","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/200/content/application~1json/examples/Deactivated virtual MCP connection"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1connections~1{connectionId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/200/content/application~1json/examples/List of virtual MCPs":{"value":{"data":[{"id":"wlp1aB2cD3eF4gH5iJ6k","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","status":"ACTIVE","profile":{"displayName":"Production MCP Servers","description":"Groups all production MCP servers for the engineering team"},"created":"2025-06-01T10:00:00Z","lastUpdated":"2025-06-15T14:30:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"}}},{"id":"wlp7lM8nO9pQ0rS1tU2v","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp7lM8nO9pQ0rS1tU2v","status":"INACTIVE","profile":{"displayName":"Staging MCP Servers","description":"Groups all staging MCP servers for testing"},"created":"2025-06-10T08:00:00Z","lastUpdated":"2025-06-10T08:00:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"}}},{"id":"wlp3wX4yZ5aB6cD7eF8g","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp3wX4yZ5aB6cD7eF8g","status":"ACTIVE","profile":{"displayName":"Development MCP Servers"},"created":"2025-06-12T12:00:00Z","lastUpdated":"2025-06-14T09:15:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp3wX4yZ5aB6cD7eF8g"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp3wX4yZ5aB6cD7eF8g"}}}],"_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers?limit=20"}}},"key":"List of virtual MCPs","summary":"List of virtual MCPs","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/200/content/application~1json/examples/List of virtual MCPs"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody/content/application~1json/examples/Create a virtual MCP":{"value":{"resourcePath":"production","profile":{"displayName":"Production MCP Servers","description":"Groups all production MCP servers for the engineering team"}},"key":"Create a virtual MCP","summary":"Create a virtual MCP","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/requestBody/content/application~1json/examples/Create a virtual MCP"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Active virtual MCP":{"value":{"id":"wlp1aB2cD3eF4gH5iJ6k","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","status":"ACTIVE","profile":{"displayName":"Production MCP Servers","description":"Groups all production MCP servers for the engineering team"},"created":"2025-06-01T10:00:00Z","lastUpdated":"2025-06-15T14:30:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"}}},"key":"Active virtual MCP","summary":"Active virtual MCP","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Active virtual MCP"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Inactive virtual MCP":{"value":{"id":"wlp7lM8nO9pQ0rS1tU2v","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp7lM8nO9pQ0rS1tU2v","status":"INACTIVE","profile":{"displayName":"Staging MCP Servers","description":"Groups all staging MCP servers for testing"},"created":"2025-06-10T08:00:00Z","lastUpdated":"2025-06-10T08:00:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp7lM8nO9pQ0rS1tU2v"}}},"key":"Inactive virtual MCP","summary":"Inactive virtual MCP","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/200/content/application~1json/examples/Inactive virtual MCP"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/get/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody/content/application~1merge-patch+json/examples/Update display name and description":{"value":{"profile":{"displayName":"Updated Production MCP Servers","description":"Updated description for the production MCP server group"}},"key":"Update display name and description","summary":"Update display name and description","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/requestBody/content/application~1merge-patch+json/examples/Update display name and description"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/200/content/application~1json/examples/Active virtual MCP":{"value":{"id":"wlp1aB2cD3eF4gH5iJ6k","orn":"orn:okta:directory:00o1gjjp4jsdR3Sww4x7:workload-principals:virtual-mcp:wlp1aB2cD3eF4gH5iJ6k","status":"ACTIVE","profile":{"displayName":"Production MCP Servers","description":"Groups all production MCP servers for the engineering team"},"created":"2025-06-01T10:00:00Z","lastUpdated":"2025-06-15T14:30:00Z","_links":{"self":{"href":"https://{yourOktaDomain}/workload-principals/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"},"resource-server":{"href":"https://{yourOktaDomain}/resource-servers/api/v1/virtual-mcp-servers/wlp1aB2cD3eF4gH5iJ6k"}}},"key":"Active virtual MCP","summary":"Active virtual MCP","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/200/content/application~1json/examples/Active virtual MCP"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/patch/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}/delete/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1activate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: {0}","errorLink":"E0000001","errorId":"sampleiCF-8D5rLW6myqiPItW","errorCauses":[]},"key":"API Validation Failed","summary":"API Validation Failed","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/400/content/application~1json/examples/API Validation Failed"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found":{"value":{"errorCode":"E0000007","errorSummary":"Not found: {0}","errorLink":"E0000007","errorId":"sampleMlLvGUj_YD5v16vkYWY","errorCauses":[]},"key":"Resource Not Found","summary":"Resource Not Found","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/404/content/application~1json/examples/Resource Not Found"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: {0}","errorLink":"E0000195","errorId":"sampleMlLvGUj_YD5v15vkYWX","errorCauses":[]},"key":"Conflict","summary":"Conflict","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/409/content/application~1json/examples/Conflict"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-servers~1{virtualMcpServerId}~1lifecycle~1deactivate/post/responses/429/content/application~1json/examples/Too Many Requests"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/200/content/application~1json/examples/Virtual MCP Settings":{"value":{"supportedConnectionTypes":["STS_ACCESS_TOKEN"],"limits":{"maxVirtualMCPs":100,"maxCapabilitiesPerVirtualMCP":1000,"maxResourceServersPerVirtualMCP":100},"features":[],"basePath":"https://subdomain.gateway.okta.com"},"key":"Virtual MCP Settings","summary":"Virtual MCP Settings","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/200/content/application~1json/examples/Virtual MCP Settings"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/403/content/application~1json/examples/Access Denied":{"value":{"errorCode":"E0000006","errorSummary":"You do not have permission to perform the requested action","errorLink":"E0000006","errorId":"sampleNUSD_8fdkFd8fs8SDBK","errorCauses":[]},"key":"Access Denied","summary":"Access Denied","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/403/content/application~1json/examples/Access Denied"},"paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/429/content/application~1json/examples/Too Many Requests":{"value":{"errorCode":"E0000047","errorSummary":"API call exceeded rate limit due to too many requests.","errorLink":"E0000047","errorId":"sampleQPivGUj_ND5v78vbYWW","errorCauses":[]},"key":"Too Many Requests","summary":"Too Many Requests","id":"paths/~1workload-principals~1api~1v1~1virtual-mcp-settings/get/responses/429/content/application~1json/examples/Too Many Requests"}},"securitySchemeStore":{"apiToken":{"id":"apiToken","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the API token as the Authorization header value prefixed with SSWS: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: SSWS {API Token}"},"children":[]}]}]}],"in":"header","paramName":"Authorization"},"ephemeralJwt":{"id":"ephemeralJwt","type":"apiKey","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ORD Ephemeral JWT for interservice authentication. Used by internal Okta services"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for example, the A0 Relay) to authenticate through short-lived X.509-backed JWTs."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The JWT is signed with an ephemeral private key; the full certificate chain is"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"embedded in the JWT "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"x5c"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" header parameter and validated against the trusted"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Infrastructure CA certificate chain. Pass as: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: SSWS {jwt}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authorization"},"oauth2":{"id":"oauth2","type":"oauth2","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Pass the access_token as the value of the Authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {access_token}"},"children":[]}]}]}],"flows":{"authorizationCode":{"authorizationUrl":"/oauth2/v1/authorize","tokenUrl":"/oauth2/v1/token","scopes":{"okta.agentGateway.read":"Allows the app to read agent gateway configuration.","okta.aiAgents.manage":"Allows the app to manage AI agents in your Okta organization.","okta.aiAgents.read":"Allows the app to read information about AI agents in your Okta organization.","okta.authorizationServers.read":"Allows the app to read information about Authorization Servers in your Okta organization.","okta.resourceServers.apiServers.manage":"Allows the app to manage API servers in your Okta organization.","okta.resourceServers.apiServers.read":"Allows the app to read information about API servers in your Okta organization.","okta.resourceServers.clientAuthSettings.manage":"Allows the app to manage client authentication settings for resource servers in your Okta organization.","okta.resourceServers.clientAuthSettings.read":"Allows the app to read client authentication settings for resource servers in your Okta organization.","okta.resourceServers.manage":"Allows the app to manage resource servers in your Okta organization.","okta.resourceServers.mcpServers.manage":"Allows the app to manage MCP servers in your Okta organization.","okta.resourceServers.mcpServers.read":"Allows the app to read information about MCP servers in your Okta organization.","okta.resourceServers.read":"Allows the app to read information about resource servers in your Okta organization.","okta.resourceServers.virtualMcpServers.manage":"Allows the app to manage virtual MCP servers in your Okta organization.","okta.resourceServers.virtualMcpServers.read":"Allows the app to read information about virtual MCP servers in your Okta organization."}}}}},"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com","description":"The domain of your organization. This can be a provided subdomain of an official okta domain (okta.com, oktapreview.com, etc) or one of your configured custom domains."}}}]},"options":{"hideInfoMetadata":true,"hideDownloadButtons":true,"hideReplay":true,"layout":"three-panel","sanitize":true,"codeSamples":{"languages":[{"lang":"curl"},{"lang":"C#"},{"lang":"Java"},{"lang":"JavaScript"},{"lang":"Node.js"},{"lang":"Python"},{"lang":"Go"},{"lang":"PHP"},{"lang":"Ruby"},{"lang":"Payload"}]},"feedback":{"hide":true,"settings":{"label":""}},"hideSidebar":true,"mockServer":{"off":true},"disableRouter":true,"downloadUrls":[{"url":"/docs/api/_bundle/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals.json?download"},{"url":"/docs/api/_bundle/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Okta for AI Agents","description":"APIs for registering, managing, and securing AI agents and their connections to resources in your Okta org."}},"baseSlug":"/secures-ai/openapi/secures-ai-workload-principals/secures-ai-workload-principals","routesMapping":{}}