{"items":[{"type":"link","label":"Okta Governance API","link":"/iga/openapi/governance-production-reference","routeSlug":"/iga/openapi/governance-production-reference","content":{"contentType":"overview","meta":{"name":"Okta Governance API"},"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 Governance API","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Allows customers to easily access the Okta API"}],"sectionId":"/iga/openapi/governance-production-reference"},{"nodeType":"external-docs","url":"https://developer.okta.com/docs/reference/core-okta-api/#design-principles","description":"Find more info here"}],"sectionId":"/iga/openapi/governance-production-reference"}]}]}},{"type":"group","label":"Campaigns","link":"/iga/openapi/governance-production-reference/campaigns","routeSlug":"/iga/openapi/governance-production-reference/campaigns","items":[{"label":"Create a campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/createcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/createcampaign","metadata":{"seo":{"title":"Create a campaign","description":"OAuth 2.0 scope:okta.governance.accessCertifications.manageAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCampaign","name":"Create a campaign","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1campaigns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a campaign","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a campaign that governs access to resources."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the following for a campaign:"},"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":"resourceSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Which resources are subject to review"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalScopeSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Which users with access to the resources are subject to review"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The schedule of the campaign"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Who needs to review access"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remediationSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": What needs to be done after access is reviewed"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"notificationSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Configure automatic notifications to a campaign creator or reviewer"},"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":"Notes:"},"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":"You can certify access to service accounts that are managed in Okta Privileged Access if you're also subscribed to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-pam-overview"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Privileged Access"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=csh-certify-service-accounts"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certify service accounts"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product documentation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can certify AI agent access to resource connections if you're also subscribed to "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ai-agents"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta for AI Agents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ai-agents-create-identity-campaigns-to-certify-resource-connections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create identity campaigns to certify resource connections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This is a self-service Early Access feature. Enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource Access Certifications for AI Agents"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in your org. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext_Manage_Early_Access_features"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable self-service features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/campaign-mutable","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n"]}},"schemaId":"components/schemas/campaign-mutable","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n"],"pointer":"/paths/~1governance~1api~1v1~1campaigns/post/requestBody","description":"Specifies the characteristics of a single campaign"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/campaigns","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/campaign-mutable","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n"]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/campaigns","href":"campaigns/createcampaign","openApiOperationId":"createCampaign","summary":"Create a campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/campaign-mutable","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/campaign-mutable","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n"]}},"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 campaign create response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list."]}},"schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list."],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to define a campaign","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1campaigns/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign with targeted apps through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign that targets groups through governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying Okta service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying SaaS app service accounts","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections using governance label values","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.","paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list."]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/campaigns"},{"label":"List all campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/listcampaigns","routeSlug":"/iga/openapi/governance-production-reference/campaigns/listcampaigns","metadata":{"seo":{"title":"List all campaigns","description":"OAuth 2.0 scope:okta.governance.accessCertifications.readAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCampaigns","name":"List all campaigns","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1campaigns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all campaigns","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all or a subset of campaigns in your organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to narrow results with the following campaign properties - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"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":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"recurringCampaignId"},"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":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?orderBy="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter to get ordered results with the following campaign properties - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"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":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, results are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1378","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply various filters by using supported campaign filtering properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"FilterByCampaignName":{"summary":"Filter by campaign name","value":"name eq \"Sales Review\""},"FilterByCampaignStatus":{"summary":"Filter by campaign status","value":"status eq \"SCHEDULED\""},"FilterByMultipleCampaignStatus":{"summary":"Filter by multiple campaign status","value":"status eq \"COMPLETED\" OR status eq \"SCHEDULED\""},"FilterByStartDate":{"summary":"Filter by start date","value":"startDate gt \"2022-05-24T14:15:22Z\""},"FilterByEndDate":{"summary":"Filter by end date","value":"endDate gt \"2022-05-24T14:15:22Z\""},"FilterByScheduleTypeOneOff":{"value":"scheduleType eq ONE_OFF"},"FilterByScheduleTypeRecurring":{"value":"scheduleType eq RECURRING"},"FilterByReviewerTypeUser":{"value":"reviewerType eq USER"},"FilterByReviewerTypeGroup":{"value":"reviewerType eq GROUP"},"FilterByReviewerTypeGroupOwner":{"value":"reviewerType eq RESOURCE_OWNER"},"FilterByReviewerTypeMultiLevel":{"value":"reviewerType eq MULTI_LEVEL"},"FilterByRecurringCampaignId":{"value":"recurringCampaignId eq \"icijNW29nev6qyksD0g1\""}}},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"orderBy","in":"query","schemaId":"schema_1381","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an ordering of campaigns by specifying a supported campaign property name with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"OrderByName":{"summary":"Order by name","value":"name desc"},"OrderByCreated":{"summary":"Order by created","value":"created desc"},"OrderByStartDate":{"summary":"Order by startDate","value":"startDate desc"},"OrderByEndDate":{"summary":"Order by endDate","value":"endDate desc"},"OrderByStatus":{"summary":"Order by status","value":"status desc"}}}],"pointer":"/paths/~1governance~1api~1v1~1campaigns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/campaigns","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"name eq \"Sales Review\"","schemaId":"schema_1378"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"orderBy","in":"query","required":false,"example":"name desc","schemaId":"schema_1381","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/campaigns","href":"campaigns/listcampaigns","openApiOperationId":"listCampaigns","summary":"List all campaigns"},"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 campaign list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/campaigns-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status."]}},"schemaId":"components/schemas/campaigns-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status."],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid list request error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1campaigns/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/campaigns-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/campaigns-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status."]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/campaigns"},{"label":"Retrieve a campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/getcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/getcampaign","metadata":{"seo":{"title":"Retrieve a campaign","description":"OAuth 2.0 scope:okta.governance.accessCertifications.readAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCampaign","name":"Retrieve a campaign","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a campaign","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the full representation of a specific campaign."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More information is returned than the abbreviated representation in a List campaigns operation."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the campaign","required":true}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/campaigns/{campaignId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/campaigns/{campaignId}","href":"campaigns/getcampaign","openApiOperationId":"getCampaign","summary":"Retrieve a campaign"},"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 campaign list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."]}},"schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/campaign-full","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/campaigns/{campaignId}"},{"label":"Delete a campaign","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/deletecampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/deletecampaign","metadata":{"seo":{"title":"Delete a campaign","description":"OAuth 2.0 scope:okta.governance.accessCertifications.manageAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCampaign","name":"Delete a campaign","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a campaign","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a campaign from your organization."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only campaigns with a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be deleted. Attempting this operation with campaigns in any other status yields a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response indicating the state of the campaign is incompatible with the delete operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the campaign being deleted has a schedule type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then any occurence of future campaigns as per recurring schedule, will not happen."},"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":" There is a limit on the number of campaigns with a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Deleting campaigns that are never meant to be launched (whether through the launch operation or automatically through "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), can be useful to remain under this limit."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the campaign","required":true}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/campaigns/{campaignId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","401","403","404","409","429","500"],"pointer":"/governance/api/v1/campaigns/{campaignId}","href":"campaigns/deletecampaign","openApiOperationId":"deleteCampaign","summary":"Delete a campaign"},"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":"A successful campaign delete response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"Attempting to perform an operation on a recurring, non-SCHEDULED, or non-ERROR campaign error response.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/409/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/campaigns/{campaignId}"},{"label":"Launch a campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/launchcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/launchcampaign","metadata":{"seo":{"title":"Launch a campaign","description":"OAuth 2.0 scope:okta.governance.accessCertifications.manageAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"launchCampaign","name":"Launch a campaign","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Launch a campaign","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Launches a campaign to initiate the assignment of reviews to reviewers, regardless of pre-configured "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleSettings"},"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":"Only campaigns with a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SCHEDULED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be launched. A valid launch operation transitions a campaign to a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"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":"If the campaign being launched has a recurring schedule, then it launches the next occurence of the campaign as per the schedule."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attempting this operation with campaigns in any other status yields a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response indicating the state of the campaign is incompatible with the launch operation."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the campaign being launched has a recurring definition, on successful response, one should get the newly launched campaign resource endpoint in HTTP header "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"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 is optional. Typically, campaigns are launched automatically according to the campaign's schedule settings ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the campaign","required":true}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/campaigns/{campaignId}/launch","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["202","401","403","404","409","429","500"],"pointer":"/governance/api/v1/campaigns/{campaignId}/launch","href":"campaigns/launchcampaign","openApiOperationId":"launchCampaign","summary":"Launch a campaign"},"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":"A successful campaign launch response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"},"Location":{"$ref":"#/components/headers/campaign-accepted-location"}},"headerSchemaId":"schema_1383"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/404/content/application~1json/example"]},{"code":"409","description":"When attempting to perform an operation on a recurring or non SCHEDULED campaign.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a recurring campaign","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a launched campaign"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a recurring campaign","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a launched campaign"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a recurring campaign","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a launched campaign"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a recurring campaign","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a launched campaign"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/campaigns/{campaignId}/launch"},{"label":"End a campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/campaigns/endcampaign","routeSlug":"/iga/openapi/governance-production-reference/campaigns/endcampaign","metadata":{"seo":{"title":"End a campaign","description":"OAuth 2.0 scope:okta.governance.accessCertifications.manageAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"endCampaign","name":"End a campaign","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"End a campaign","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Ends a campaign before its scheduled end date (from "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleSettings"},"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":"This operation closes any open reviews and prevents any further review activity, such as decisions or reassignments. Reviews associated with the campaign are remediated, if the remediation setting for the campaign is set."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only campaigns with a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be completed. A valid end operation transitions a campaign to a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Attempting this operation with campaigns in any other status yields a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"409 Conflict"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response indicating the state of the campaign is incompatible with the end campaign operation."},"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 is optional. Typically, campaigns are completed automatically according to the campaign's schedule settings "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the campaign","required":true}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":false,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/campaign-end-skip-remediation","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody/content/application~1json/examples/createCampaignForGroupAccess"]}},"schemaId":"components/schemas/campaign-end-skip-remediation","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody/content/application~1json/examples/createCampaignForGroupAccess"],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody","description":"Ends a campaign with the option to skip remediation."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/campaigns/{campaignId}/end","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/campaign-end-skip-remediation","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody/content/application~1json/examples/createCampaignForGroupAccess"]}},"responseCodes":["202","401","403","404","409","429","500"],"pointer":"/governance/api/v1/campaigns/{campaignId}/end","href":"campaigns/endcampaign","openApiOperationId":"endCampaign","summary":"End a campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/campaign-end-skip-remediation","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody/content/application~1json/examples/createCampaignForGroupAccess"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/campaign-end-skip-remediation","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody/content/application~1json/examples/createCampaignForGroupAccess"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A successful campaign complete response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"},"Location":{"$ref":"#/components/headers/campaign-ended-location"}},"headerSchemaId":"schema_1384"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/404/content/application~1json/example"]},{"code":"409","description":"When the campaign status is not ACTIVE.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/409/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/409/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/campaigns/{campaignId}/end"}],"content":{"contentType":"group","meta":{"name":"Campaigns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaigns","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":"Access certification campaigns allow key stakeholders to periodically review users’ access to resources. Okta can then modify resource access, based on stakeholder reviews. Manage campaign tasks with the following campaign APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-iga"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identity Governance"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information on access certification campaigns and Identity Governance."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/campaigns","summary":"Create a campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/createcampaign","deprecated":false},{"title":"/governance/api/v1/campaigns","summary":"List all campaigns","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/listcampaigns","deprecated":false},{"title":"/governance/api/v1/campaigns/{campaignId}","summary":"Retrieve a campaign","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/getcampaign","deprecated":false},{"title":"/governance/api/v1/campaigns/{campaignId}","summary":"Delete a campaign","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/campaigns/deletecampaign","deprecated":false},{"title":"/governance/api/v1/campaigns/{campaignId}/launch","summary":"Launch a campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/launchcampaign","deprecated":false},{"title":"/governance/api/v1/campaigns/{campaignId}/end","summary":"End a campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/endcampaign","deprecated":false}]}]}]}]}},{"type":"group","label":"Reviews","link":"/iga/openapi/governance-production-reference/reviews","routeSlug":"/iga/openapi/governance-production-reference/reviews","items":[{"label":"List all reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/reviews/listreviews","routeSlug":"/iga/openapi/governance-production-reference/reviews/listreviews","metadata":{"seo":{"title":"List all reviews","description":"OAuth 2.0 scope:okta.governance.accessCertifications.readAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listReviews","name":"List all reviews","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1reviews/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all reviews","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists reviews in your org:"},"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":"Reviews exist only for campaigns that have been launched with a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"COMPLETED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a review hasn't been reviewed ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNREVIEWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is null."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If remediation isn't done on a review, then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remediationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is null."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This operation supports pagination. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters to page through the list, and follow the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Link"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response header to retrieve the next page of results."},"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":": Requesting a list of reviews without a filter impacts performance. If your org has a large number of campaigns and reviews, the request might time out or fail. Okta recommends that you list reviews on a per-campaign basis, using the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1378","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters a collection of reviews in the response."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The filter 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":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the following properties:"},"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":"campaignId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalProfile.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerProfile.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"currentReviewerLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementValueId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementValue.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementBundleId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (corresponds to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementBundle.id"},"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":" Query parameter percent encoding is required. See "},"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":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"FilterByCampaignId":{"summary":"Filter by campaign ID","value":"campaignId eq \"icitdyhndQ6qstyvR8g5\""},"FilterByReviewDecision":{"summary":"Filter by review decision","value":"decision eq \"UNREVIEWED\""},"FilterByReviewerId":{"summary":"Filter by reviewer ID","value":"reviewerId eq \"00u5v5viPvg84h0W68g4\""},"FilterByGroupResourceId":{"summary":"Filter by group resource ID","value":"resourceId eq \"00gyqjxNrsh764hjs784\""},"FilterByAppResourceId":{"summary":"Filter by app resource ID","value":"resourceId eq \"00ayqjxNrZD11n4w40g3\""},"FilterByPrincipalId":{"summary":"Filter by principal user ID","value":"principalId eq \"00u5v5viPvg84h0W68g4\""},"FilterByReviewerType":{"summary":"Filter by reviewerType","value":"reviewerType eq \"USER\""},"FilterByReviewerLevel":{"summary":"Filter by reviewer level","value":"reviewerLevel eq \"FIRST\""},"FilterByEntitlementId":{"summary":"Filter by entitlement value ID","value":"entitlementValueId eq \"enthzzPJAXvaYQ71T0g3\""},"FilterByEntitlementType":{"summary":"Filter by entitlement bundle ID","value":"entitlementBundleId eq \"enbisi7xt3iBd39Bn0g3\""}}},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"orderBy","in":"query","schemaId":"schema_1381","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies a property to sort the results. The following properties are supported:"},"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":"decided"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decision"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remediationStatus"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Append "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate the sorting direction."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, the results are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in ascending order ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created asc"},"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":" Query parameter percent encoding is required. See "},"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":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"OrderByDecided":{"summary":"Order by decided","value":"decided desc"},"OrderByDecision":{"summary":"Order by decision","value":"decision desc"},"OrderByRemediationStatus":{"summary":"Order by remediationStatus","value":"remediationStatus desc"},"OrderByCreated":{"summary":"Order by created","value":"created desc"}}}],"pointer":"/paths/~1governance~1api~1v1~1reviews/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/reviews","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"campaignId eq \"icitdyhndQ6qstyvR8g5\"","schemaId":"schema_1378"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"orderBy","in":"query","required":false,"example":"decided desc","schemaId":"schema_1381","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","500"],"pointer":"/governance/api/v1/reviews","href":"reviews/listreviews","openApiOperationId":"listReviews","summary":"List all reviews"},"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 review list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/review-list","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by resource ID","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID"]}},"schemaId":"components/schemas/review-list","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by resource ID","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid list request error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/403/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1reviews/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/review-list","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by resource ID","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/review-list","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by resource ID","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.","paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/403/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/reviews"},{"label":"Reassign the reviews","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/reviews/reassignreviews","routeSlug":"/iga/openapi/governance-production-reference/reviews/reassignreviews","metadata":{"seo":{"title":"Reassign the reviews","description":"OAuth 2.0 scope:okta.governance.accessCertifications.manageAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"reassignReviews","name":"Reassign the reviews","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reassign the reviews","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reassigns a review to another reviewer."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Reassigning a review is useful in cases where the currently assigned reviewer is not able to make a decision before the campaign ends."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only reviews belonging to campaigns with a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be reassigned. And only those reviews with decision "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNREVIEWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be reassigned."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If reviews are currently being reviewed by a group (when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_OWNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), on reassignment, reviews is directly assigned to the chosen new reviewer and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is changed to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"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 valid reassignment changes an existing reviewer to a new reviewer ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), and appends the change to the reassignment history."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"To reassign a set of reviews, you must specify:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":false,"marker":"-"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the Okta "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"user.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the new reviewer"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to be re-assigned"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"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":"reviewerLevel"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" at which the reviews needs to be re-assigned (Applicable only for multi level campaigns)"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"note"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" justifying the reassignment decision for the specified reviews"},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"campaignId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the campaign","required":true}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/reviews-reassign","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign success","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned"]}},"schemaId":"components/schemas/reviews-reassign","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign success","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned"],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody","description":"The operation payload for reviews reassignment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/campaigns/{campaignId}/reviews/reassign","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"campaignId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/reviews-reassign","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign success","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned"]}},"responseCodes":["200","400","401","403","409","500"],"pointer":"/governance/api/v1/campaigns/{campaignId}/reviews/reassign","href":"reviews/reassignreviews","openApiOperationId":"reassignReviews","summary":"Reassign the reviews"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/reviews-reassign","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign success","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/reviews-reassign","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign success","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned"]}},"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 reassign reviews response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/review-reassign-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."]}},"schemaId":"components/schemas/review-reassign-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to reassign reviews","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/403/content/application~1json/example"]},{"code":"409","description":"When the review(s) is/are already reassigned to intended reviewer.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/409/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/409/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/review-reassign-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/review-reassign-list","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/403/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/409/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/409/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/campaigns/{campaignId}/reviews/reassign"},{"label":"Retrieve a review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/reviews/getreview","routeSlug":"/iga/openapi/governance-production-reference/reviews/getreview","metadata":{"seo":{"title":"Retrieve a review","description":"OAuth 2.0 scope:okta.governance.accessCertifications.readAdmin roles:ACCESS_CERTIFICATIONS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getReview","name":"Retrieve a review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1reviews~1{reviewId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a review","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.governance.accessCertifications.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":"ACCESS_CERTIFICATIONS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the full representation of a specific review."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"More information is returned than the abbreviated representation in a List reviews operation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Also note that, if reviews are still "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNREVIEWED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the property "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"decided"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be null. If the remediation is not completed, then "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remediationStatus"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" would be null too."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"reviewId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the review","required":true}],"pointer":"/paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/reviews/{reviewId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"reviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/reviews/{reviewId}","href":"reviews/getreview","openApiOperationId":"getReview","summary":"Retrieve a review"},"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 review response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/review-full","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details |tooltip| Success response to get a review details.","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."]}},"schemaId":"components/schemas/review-full","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details |tooltip| Success response to get a review details.","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."],"headers":{"Link":{"$ref":"#/components/headers/reviewlink"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1385"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/review-full","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details |tooltip| Success response to get a review details.","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/review-full","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details |tooltip| Success response to get a review details.","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile","paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/reviews/{reviewId}"}],"content":{"contentType":"group","meta":{"name":"Reviews"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reviews","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":"Okta access certification reviews evaluate and make decisions about a user’s current resource access. Each review is associated with one campaign, whereas a campaign can contain many reviews. Retrieve and reassign reviews with the following reviews APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-ac-review-campaign"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Review an access certification campaign"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information on the review process."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/reviews","summary":"List all reviews","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviews/listreviews","deprecated":false},{"title":"/governance/api/v1/campaigns/{campaignId}/reviews/reassign","summary":"Reassign the reviews","prefix":{"name":"post","color":"post"},"badges":[],"link":"/reviews/reassignreviews","deprecated":false},{"title":"/governance/api/v1/reviews/{reviewId}","summary":"Retrieve a review","prefix":{"name":"get","color":"get"},"badges":[],"link":"/reviews/getreview","deprecated":false}]}]}]}]}},{"type":"group","label":"Entitlements","link":"/iga/openapi/governance-production-reference/entitlements","routeSlug":"/iga/openapi/governance-production-reference/entitlements","items":[{"label":"Create an entitlement","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/createentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/createentitlement","metadata":{"seo":{"title":"Create an entitlement","description":"OAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlement","name":"Create an entitlement","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an entitlement","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a new entitlement"},"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":" An HTTP 404 Not Found error is returned for app entitlements that aren't enabled with entitlement management."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=csh-enable-ge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Entitlement management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-create","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/requestBody/content/application~1json/examples/New entitlement |tooltip| Request body for adding an entitlement"]}},"schemaId":"components/schemas/entitlement-create","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/requestBody/content/application~1json/examples/New entitlement |tooltip| Request body for adding an entitlement"],"pointer":"/paths/~1governance~1api~1v1~1entitlements/post/requestBody","description":"The writable attributes of an entitlement"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/entitlements","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/entitlement-create","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/requestBody/content/application~1json/examples/New entitlement |tooltip| Request body for adding an entitlement"]}},"responseCodes":["201","400","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlements","href":"entitlements/createentitlement","openApiOperationId":"createEntitlement","summary":"Create an entitlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/entitlement-create","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/requestBody/content/application~1json/examples/New entitlement |tooltip| Request body for adding an entitlement"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-create","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/requestBody/content/application~1json/examples/New entitlement |tooltip| Request body for adding an entitlement"]}},"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 entitlement creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/201/content/application~1json/examples/Create entitlement example |tooltip| Response for a successful entitlement creation"]}},"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/201/content/application~1json/examples/Create entitlement example |tooltip| Response for a successful entitlement creation"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to create or update an entitlement","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/201/content/application~1json/examples/Create entitlement example |tooltip| Response for a successful entitlement creation"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/201/content/application~1json/examples/Create entitlement example |tooltip| Response for a successful entitlement creation"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements"},{"label":"List all entitlements","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/listentitlements","routeSlug":"/iga/openapi/governance-production-reference/entitlements/listentitlements","metadata":{"seo":{"title":"List all entitlements","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlements","name":"List all entitlements","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all entitlements","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all entitlements specific to a resource"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"parent.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"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 with ISO-8601 datetime format"},"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":[]}]}]}]}],"required":true,"examples":{"FilterByResource":{"summary":"Filter by resource","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\""},"FilterByResourceORN":{"summary":"Filter by resource ORN representing a single resource","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""},"FilterByNameStartsWith":{"summary":"Filter by the entitlement name, starting with the provided prefix","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND name sw \"License\""},"FilterByNameContains":{"summary":"Filter by the entitlement name that contains the provided substring","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND name co \"License\""},"FilterId":{"summary":"Filter by resource and entitlement IDs","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND (id eq \"espfxqCAJWWGELFTYASJ\" OR id eq \"espfxqCAJWWGELFTYASI\")"},"FilterByExternalValue":{"summary":"Filter by a resource and an external value","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND externalValue eq \"License\""},"FilterByCreatedAfter":{"summary":"Filter by entitlements created after a specific date","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND created gt \"2026-01-01T00:00:00.000Z\""}}},{"name":"orderBy","in":"query","schemaId":"schema_1387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field by which results can be sorted. For now, sorting by a single field is supported."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"OrderByName":{"summary":"Order by name","value":"name asc"},"OrderByCreated":{"summary":"Order by created","value":"created desc"}}}],"pointer":"/paths/~1governance~1api~1v1~1entitlements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/entitlements","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"filter","in":"query","required":true,"example":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\"","schemaId":"components/schemas/scim-filter"},{"name":"orderBy","in":"query","required":false,"example":"name asc","schemaId":"schema_1387","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlements","href":"entitlements/listentitlements","openApiOperationId":"listEntitlements","summary":"List all entitlements"},"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 entitlements list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/200/content/application~1json/examples/List entitlements for a specific resource |tooltip| A list of entitlements"]}},"schemaId":"components/schemas/entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/200/content/application~1json/examples/List entitlements for a specific resource |tooltip| A list of entitlements"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid request to list entitlement-bundles","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/400/content/application~1json/examples/When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/400/content/application~1json/examples/When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/200/content/application~1json/examples/List entitlements for a specific resource |tooltip| A list of entitlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/200/content/application~1json/examples/List entitlements for a specific resource |tooltip| A list of entitlements"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/400/content/application~1json/examples/When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/400/content/application~1json/examples/When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements"},{"label":"Delete an entitlement","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/deleteentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/deleteentitlement","metadata":{"seo":{"title":"Delete an entitlement","description":"OAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntitlement","name":"Delete an entitlement","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an entitlement","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes entitlement"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/entitlements/{entitlementId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","401","403","429","500"],"pointer":"/governance/api/v1/entitlements/{entitlementId}","href":"entitlements/deleteentitlement","openApiOperationId":"deleteEntitlement","summary":"Delete an entitlement"},"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":"A successful entitlement delete response","headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"Retrieve an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/getentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/getentitlement","metadata":{"seo":{"title":"Retrieve an entitlement","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlement","name":"Retrieve an entitlement","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an entitlement","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single entitlement"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/entitlements/{entitlementId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlements/{entitlementId}","href":"entitlements/getentitlement","openApiOperationId":"getEntitlement","summary":"Retrieve an entitlement"},"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 entitlements list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/200/content/application~1json/examples/Retrieve an entitlement response |tooltip| Retrieve an entitlement response"]}},"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/200/content/application~1json/examples/Retrieve an entitlement response |tooltip| Retrieve an entitlement response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/200/content/application~1json/examples/Retrieve an entitlement response |tooltip| Retrieve an entitlement response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/200/content/application~1json/examples/Retrieve an entitlement response |tooltip| Retrieve an entitlement response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"Replace an entitlement","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/replaceentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/replaceentitlement","metadata":{"seo":{"title":"Replace an entitlement","description":"OAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceEntitlement","name":"Replace an entitlement","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace an entitlement","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces an entitlement's name, description, or values. This API requires a complete list of updated values, which may present limitations for certain use cases. For more practical and flexible usage, consider using the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/iga/openapi/governance-production-reference/entitlements/updateentitlement"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Update the entitlement"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody/content/application~1json/examples/Update an entitlement |tooltip| Request body for updating an entitlement"]}},"schemaId":"components/schemas/entitlement-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody/content/application~1json/examples/Update an entitlement |tooltip| Request body for updating an entitlement"],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody","description":"The writable attributes of an entitlement"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v1/entitlements/{entitlementId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/entitlement-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody/content/application~1json/examples/Update an entitlement |tooltip| Request body for updating an entitlement"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/entitlements/{entitlementId}","href":"entitlements/replaceentitlement","openApiOperationId":"replaceEntitlement","summary":"Replace an entitlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/entitlement-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody/content/application~1json/examples/Update an entitlement |tooltip| Request body for updating an entitlement"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody/content/application~1json/examples/Update an entitlement |tooltip| Request body for updating an entitlement"]}},"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 entitlement update operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"]}},"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to create or update an entitlement","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"Update the entitlement","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/updateentitlement","routeSlug":"/iga/openapi/governance-production-reference/entitlements/updateentitlement","metadata":{"seo":{"title":"Update the entitlement","description":"OAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEntitlement","name":"Update the entitlement","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the entitlement","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates an entitlement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a particular "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array in the response contains only the updated entitlement values. No entitlement values are returned if the name and description is updated or values are only removed in the update."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-patch","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update entitlement |tooltip| Request body for updating entitlement","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - add entitlement value |tooltip| Request body for adding entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - remove entitlement value |tooltip| Request body for removing entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - replace entitlement value |tooltip| Request body for replacing entitlement value"]}},"schemaId":"components/schemas/entitlement-patch","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update entitlement |tooltip| Request body for updating entitlement","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - add entitlement value |tooltip| Request body for adding entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - remove entitlement value |tooltip| Request body for removing entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - replace entitlement value |tooltip| Request body for replacing entitlement value"],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody","description":"The writable attributes of an entitlement."}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/entitlements/{entitlementId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/entitlement-patch","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update entitlement |tooltip| Request body for updating entitlement","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - add entitlement value |tooltip| Request body for adding entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - remove entitlement value |tooltip| Request body for removing entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - replace entitlement value |tooltip| Request body for replacing entitlement value"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/entitlements/{entitlementId}","href":"entitlements/updateentitlement","openApiOperationId":"updateEntitlement","summary":"Update the entitlement"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/entitlement-patch","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update entitlement |tooltip| Request body for updating entitlement","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - add entitlement value |tooltip| Request body for adding entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - remove entitlement value |tooltip| Request body for removing entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - replace entitlement value |tooltip| Request body for replacing entitlement value"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-patch","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update entitlement |tooltip| Request body for updating entitlement","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - add entitlement value |tooltip| Request body for adding entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - remove entitlement value |tooltip| Request body for removing entitlement value","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - replace entitlement value |tooltip| Request body for replacing entitlement value"]}},"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 entitlement update operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"]}},"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to create or update an entitlement","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlements-full-with-parent","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements/{entitlementId}"},{"label":"List all values for an entitlement","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/listentitlementvalues","routeSlug":"/iga/openapi/governance-production-reference/entitlements/listentitlementvalues","metadata":{"seo":{"title":"List all values for an entitlement","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlementValues","name":"List all values for an entitlement","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all values for an entitlement","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all values for an entitlement"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":supports the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labelValueId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"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 with ISO-8601 datetime format"},"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":[]}]}]}]}],"examples":{"FilterByNameStartsWith":{"summary":"Filter by entitlement name, starting with the provided prefix","value":"name sw \"License\""},"FilterByNameContains":{"summary":"Filter by the entitlement name that contains the provided substring","value":"name co \"License\""},"FilterByCreatedAfter":{"summary":"Filter by entitlement values created after a specific date","value":"created gt \"2026-01-30T10:00:00.000Z\""},"FilterByCreatedBefore":{"summary":"Filter by entitlement values created before a specific date","value":"created lt \"2026-01-30T10:00:00.000Z\""},"FilterByLabelValueId":{"summary":"Filter by a label value id","value":"labelValueId eq \"lblo3v6xlwdtEX2il1d6\""}}},{"name":"orderBy","in":"query","schemaId":"schema_1387","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field by which results can be sorted. For now, sorting by a single field is supported."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"OrderByName":{"summary":"Order by name","value":"name asc"},"OrderByCreated":{"summary":"Order by created","value":"created desc"}}}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/entitlements/{entitlementId}/values","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"filter","in":"query","required":false,"example":"name sw \"License\"","schemaId":"components/schemas/scim-filter"},{"name":"orderBy","in":"query","required":false,"example":"name asc","schemaId":"schema_1387","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlements/{entitlementId}/values","href":"entitlements/listentitlementvalues","openApiOperationId":"listEntitlementValues","summary":"List all values for an entitlement"},"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 list of entitlement values response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"]}},"schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements/{entitlementId}/values"},{"label":"Retrieve an entitlement value","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/getentitlementvalue","routeSlug":"/iga/openapi/governance-production-reference/entitlements/getentitlementvalue","metadata":{"seo":{"title":"Retrieve an entitlement value","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementValue","name":"Retrieve an entitlement value","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an entitlement value","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a single entitlement value"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement","required":true},{"name":"valueId","in":"path","schemaId":"schema_1378","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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the entitlement value"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/entitlements/{entitlementId}/values/{valueId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"valueId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlements/{entitlementId}/values/{valueId}","href":"entitlements/getentitlementvalue","openApiOperationId":"getEntitlementValue","summary":"Retrieve an entitlement value"},"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 entitlement value response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-value-2","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/200/content/application~1json/examples/Entitlement value data |tooltip| Entitlement value data"]}},"schemaId":"components/schemas/entitlement-value-2","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/200/content/application~1json/examples/Entitlement value data |tooltip| Entitlement value data"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement-value-2","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/200/content/application~1json/examples/Entitlement value data |tooltip| Entitlement value data"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-value-2","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/200/content/application~1json/examples/Entitlement value data |tooltip| Entitlement value data"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements/{entitlementId}/values/{valueId}"},{"label":"List all entitlement values","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlements/listallentitlementvalues","routeSlug":"/iga/openapi/governance-production-reference/entitlements/listallentitlementvalues","metadata":{"seo":{"title":"List all entitlement values","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listAllEntitlementValues","name":"List all entitlement values","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlements~1values/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all entitlement values","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all entitlement values"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_1388","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"parent.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parent.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalValue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"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 with ISO-8601 datetime format"},"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":[]}]}]}]}],"required":true,"examples":{"FilterByResource":{"summary":"Filter by a specific resource ID and type","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\""},"FilterByResourceORN":{"summary":"Filter by resource ORN representing a single resource","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""},"FilterByNameStartsWith":{"summary":"Filter by the entitlement value name, starting with the provided prefix","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND name sw \"License\""},"FilterByNameContains":{"summary":"Filter by the entitlement value name that contains the provided substring for a specific resource","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND name co \"License\""},"FilterId":{"summary":"Filter by a specific resource and entitlement IDs","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND (entitlementId eq \"espfxqCAJWWGELFTYASJ\" OR entitlementId eq \"espfxqCAJWWGELFTYASI\")"},"FilterByExternalValue":{"summary":"Filter by external value","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND externalValue eq \"corporate\""},"FilterByCreatedAfter":{"summary":"Filter by entitlement values created after a specific date","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND created gt \"2026-01-30T10:00:00.000Z\""},"FilterByCreatedBefore":{"summary":"Filter by entitlement values created before a specific date","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND created lt \"2026-01-30T10:00:00.000Z\""}}},{"name":"orderBy","in":"query","schemaId":"schema_1389","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field by which results can be sorted. For now, sorting by a single field is supported."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"OrderByName":{"summary":"Order by name","value":"name asc"},"OrderById":{"summary":"Order by id","value":"id desc"}}}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1values/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/entitlements/values","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_1388"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"filter","in":"query","required":true,"example":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\"","schemaId":"components/schemas/scim-filter"},{"name":"orderBy","in":"query","required":false,"example":"name asc","schemaId":"schema_1389","style":"form","explode":false}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlements/values","href":"entitlements/listallentitlementvalues","openApiOperationId":"listAllEntitlementValues","summary":"List all entitlement values"},"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 list of entitlement values response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"]}},"schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlements~1values/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-values-list","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlements~1values/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlements/values"}],"content":{"contentType":"group","meta":{"name":"Entitlements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entitlements","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 Entitlements API allows you to manage entitlements and their values. An entitlement is a permission that allows users to take specific actions within a resource, such as an app. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-entitlement-mgt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product documentation."},"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":" An app must have entitlement management enabled before it can be used as an entitlement resource. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=csh-enable-ge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Entitlement management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product documentation."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/entitlements","summary":"Create an entitlement","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlements/createentitlement","deprecated":false},{"title":"/governance/api/v1/entitlements","summary":"List all entitlements","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/listentitlements","deprecated":false},{"title":"/governance/api/v1/entitlements/{entitlementId}","summary":"Delete an entitlement","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/entitlements/deleteentitlement","deprecated":false},{"title":"/governance/api/v1/entitlements/{entitlementId}","summary":"Retrieve an entitlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/getentitlement","deprecated":false},{"title":"/governance/api/v1/entitlements/{entitlementId}","summary":"Replace an entitlement","prefix":{"name":"put","color":"put"},"badges":[],"link":"/entitlements/replaceentitlement","deprecated":false},{"title":"/governance/api/v1/entitlements/{entitlementId}","summary":"Update the entitlement","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/entitlements/updateentitlement","deprecated":false},{"title":"/governance/api/v1/entitlements/{entitlementId}/values","summary":"List all values for an entitlement","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/listentitlementvalues","deprecated":false},{"title":"/governance/api/v1/entitlements/{entitlementId}/values/{valueId}","summary":"Retrieve an entitlement value","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/getentitlementvalue","deprecated":false},{"title":"/governance/api/v1/entitlements/values","summary":"List all entitlement values","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlements/listallentitlementvalues","deprecated":false}]}]}]}]}},{"type":"group","label":"Entitlement Bundles","link":"/iga/openapi/governance-production-reference/entitlement-bundles","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles","items":[{"label":"Create an entitlement bundle","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/createentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/createentitlementbundle","metadata":{"seo":{"title":"Create an entitlement bundle","description":"OAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createEntitlementBundle","name":"Create an entitlement bundle","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an entitlement bundle","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an entitlement bundle"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-creatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements"]}},"schemaId":"components/schemas/entitlement-bundle-creatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements"],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody","description":"The writable attributes of an entitlement bundle"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/entitlement-bundles","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-creatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements"]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/entitlement-bundles","href":"entitlement-bundles/createentitlementbundle","openApiOperationId":"createEntitlementBundle","summary":"Create an entitlement bundle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/entitlement-bundle-creatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-creatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements"]}},"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 entitlement bundle creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"]}},"schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to create an entitlement bundle","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/400/content/application~1json/examples/entitlementBundleSettingsMissing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/400/content/application~1json/examples/entitlementBundleSettingsMissing"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/400/content/application~1json/examples/entitlementBundleSettingsMissing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/400/content/application~1json/examples/entitlementBundleSettingsMissing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlement-bundles"},{"label":"List all entitlement bundles","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/listentitlementbundles","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/listentitlementbundles","metadata":{"seo":{"title":"List all entitlement bundles","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listEntitlementBundles","name":"List all entitlement bundles","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all entitlement bundles","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all or a subset of entitlement-bundles in your organization"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"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":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastUpdated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"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":"le"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"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":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"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":[]}]}]}]}],"examples":{"FilterByLastUpdated":{"summary":"Filter for results that were modified after a specific date","value":"lastUpdated gt \"2022-05-24T14:15:22Z\""},"FilterByLastUpdatedAndId":{"summary":"Filter for results that were modified after lastUpdated and have object IDs greater than a specific value","value":"lastUpdated ge \"2022-05-24T14:15:22Z\" AND id gt \"0bbfxqCAJWWGELFTYBBB\""},"FilterByLastUpdatedOrLastUpdatedAndId":{"summary":"Filter for results by the lastUpdated date or by the lastUpdated date and the object ID","value":"lastUpdated gt \"2022-05-24T14:15:22Z\" OR (lastUpdated ge \"2022-05-24T14:15:22Z\" AND id gt \"0bbfxqCAJWWGELFTYBBB\")"},"FilterByTargetExternalIdAndTargetType":{"summary":"Filter by target.externalId and target.type","value":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\""},"FilterByTargetResourceOrn":{"summary":"Filter by resource ORN representing a single resource","value":"targetResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""},"FilterByStatus":{"summary":"Filter by status","value":"status eq \"ACTIVE\""},"FilterByNamePrefix":{"summary":"Filter by a prefix in the name","value":"name sw \"sales\""},"FilterByNameContains":{"summary":"Filter by a name substring","value":"name co \"sales\""},"FilterBySpecificBundleIds":{"summary":"Filter by specific bundle IDs","value":"id eq \"enbg0wqnRSOEiCqvE0g5\" OR id eq \"enb673d4pGgTpgmxz0g5\""}}},{"name":"after","in":"query","schemaId":"schema_1390","description":"The after cursor provided by a prior request."},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"orderBy","in":"query","schemaId":"schema_1391","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply an ordering of entitlement-bundles by specifying a supported entitlement bundle property name with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"OrderByCreated":{"summary":"Order by created","value":"created desc"},"OrderByLastUpdated":{"summary":"Order by lastUpdated","value":"lastUpdated desc"},"OrderByLastUpdatedAndId":{"summary":"Order by lastUpdated and id","value":"lastUpdated asc,id asc"}}},{"name":"include","in":"query","schemaId":"schema_1392","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter adds additional properties that are available in the retrieve an entitlement bundle operation, but are omitted from the list response normally."},"children":[]}]}]}],"examples":{"IncludeEntitlements":{"summary":"Include entitlements in response","value":"full_entitlements"}}}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/entitlement-bundles","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"lastUpdated gt \"2022-05-24T14:15:22Z\"","schemaId":"components/schemas/scim-filter"},{"name":"after","in":"query","required":false,"schemaId":"components/schemas/entitlement-bundle-id"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"orderBy","in":"query","required":false,"example":"created desc","schemaId":"components/schemas/order-by"},{"name":"include","in":"query","required":false,"example":"full_entitlements","schemaId":"schema_1392"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlement-bundles","href":"entitlement-bundles/listentitlementbundles","openApiOperationId":"listEntitlementBundles","summary":"List all entitlement bundles"},"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 entitlement bundle list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundles-list-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements"]}},"schemaId":"components/schemas/entitlement-bundles-list-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid request to list entitlement-bundles","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement-bundles-list-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundles-list-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlement-bundles"},{"label":"Retrieve an entitlement bundle","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/getentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/getentitlementbundle","metadata":{"seo":{"title":"Retrieve an entitlement bundle","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementBundle","name":"Retrieve an entitlement bundle","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an entitlement bundle","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the full representation of a entitlement bundle"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementBundleId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement bundle","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_1392","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter adds additional properties that are available in the retrieve an entitlement bundle operation, but are omitted from the list response normally."},"children":[]}]}]}],"examples":{"IncludeEntitlements":{"summary":"Include entitlements in response","value":"full_entitlements"}}}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementBundleId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"include","in":"query","required":false,"example":"full_entitlements","schemaId":"schema_1392"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","href":"entitlement-bundles/getentitlementbundle","openApiOperationId":"getEntitlementBundle","summary":"Retrieve an entitlement bundle"},"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 entitlement bundle get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-full-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values"]}},"schemaId":"components/schemas/entitlement-bundle-full-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement-bundle-full-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-full-with-entitlements","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}"},{"label":"Replace an entitlement bundle","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/replaceentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/replaceentitlementbundle","metadata":{"seo":{"title":"Replace an entitlement bundle","description":"OAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceEntitlementBundle","name":"Replace an entitlement bundle","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace an entitlement bundle","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces an entitlement bundle's name, description or entitlements."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement updates will be applied to existing grants referencing this bundle and may change principal entitlements."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementBundleId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement bundle","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values"]}},"schemaId":"components/schemas/entitlement-bundle-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values"],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody","description":"The writable attributes of an entitlement bundle"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementBundleId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","href":"entitlement-bundles/replaceentitlementbundle","openApiOperationId":"replaceEntitlementBundle","summary":"Replace an entitlement bundle"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/entitlement-bundle-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-updatable","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values"]}},"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 entitlement bundle update response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"]}},"schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to create an entitlement bundle","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleEntitlementsMissing","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleNameMissing"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleEntitlementsMissing","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleNameMissing"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-bundle-full","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleEntitlementsMissing","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleNameMissing"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleEntitlementsMissing","paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleNameMissing"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}"},{"label":"Delete an entitlement bundle","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-bundles/deleteentitlementbundle","routeSlug":"/iga/openapi/governance-production-reference/entitlement-bundles/deleteentitlementbundle","metadata":{"seo":{"title":"Delete an entitlement bundle","description":"OAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteEntitlementBundle","name":"Delete an entitlement bundle","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an entitlement bundle","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a entitlement bundle"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"entitlementBundleId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the entitlement bundle","required":true}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"entitlementBundleId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","401","403","404","409","429","500"],"pointer":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","href":"entitlement-bundles/deleteentitlementbundle","openApiOperationId":"deleteEntitlementBundle","summary":"Delete an entitlement bundle"},"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":"A successful entitlement bundle delete response","headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/404/content/application~1json/example"]},{"code":"409","description":"An invalid request due to status conflict when deleting a entitlement bundle","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/409/content/application~1json/examples/Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/409/content/application~1json/examples/Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/404/content/application~1json/example"]}}},{"code":"409","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/409/content/application~1json/examples/Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/409/content/application~1json/examples/Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}"}],"content":{"contentType":"group","meta":{"name":"Entitlement Bundles"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entitlement Bundles","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 Entitlement Bundles API allows you to manage entitlement bundles."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement bundles allow you to grant multiple entitlements simultaneously to your users."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-entitlement-mgt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product documentation."},"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":" An app must have entitlement management enabled before it can be used as an entitlement resource. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=csh-enable-ge"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Enable Entitlement management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product documentation."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/entitlement-bundles","summary":"Create an entitlement bundle","prefix":{"name":"post","color":"post"},"badges":[],"link":"/entitlement-bundles/createentitlementbundle","deprecated":false},{"title":"/governance/api/v1/entitlement-bundles","summary":"List all entitlement bundles","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlement-bundles/listentitlementbundles","deprecated":false},{"title":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","summary":"Retrieve an entitlement bundle","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlement-bundles/getentitlementbundle","deprecated":false},{"title":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","summary":"Replace an entitlement bundle","prefix":{"name":"put","color":"put"},"badges":[],"link":"/entitlement-bundles/replaceentitlementbundle","deprecated":false},{"title":"/governance/api/v1/entitlement-bundles/{entitlementBundleId}","summary":"Delete an entitlement bundle","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/entitlement-bundles/deleteentitlementbundle","deprecated":false}]}]}]}]}},{"type":"group","label":"Grants","link":"/iga/openapi/governance-production-reference/grants","routeSlug":"/iga/openapi/governance-production-reference/grants","items":[{"type":"link","label":"Base","link":"/iga/openapi/governance-production-reference/grants/base","routeSlug":"/iga/openapi/governance-production-reference/grants/base","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Base"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"grants/base"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Base"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A principal and resource can only have a single base grant. Creating a base grant type replaces all other existing grants. The following grant types are available:"},"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":"POLICY"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Creates a grant for a principal driven by existing policy rules defined for the app."},"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":"CUSTOM"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Creates a grant for a principal with specific entitlement and respective values."},"children":[]}]}]}]}]}],"panels":[]}]}},{"type":"link","label":"Additive","link":"/iga/openapi/governance-production-reference/grants/additive","routeSlug":"/iga/openapi/governance-production-reference/grants/additive","content":{"contentType":"item","itemVariant":"markdown","meta":{"name":"Additive"},"children":[{"nodeType":"container","children":[{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"grants/additive"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additive"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A principal entitlement can have multiple additive grant types. These are applied based on the order that they were granted. The following additive grant types are available:"},"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":"ENTITLEMENT-BUNDLE"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Creates a grant for a user with a specific entitlement bundle."},"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":"ENTITLEMENT"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Creates a grant for a user with specific entitlements."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The effective grants for a principal's access to a resource are a combination of their base grant ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POLICY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and their additive grants."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-entitlement-mgt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[]}]}},{"label":"Create a grant","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/creategrant","routeSlug":"/iga/openapi/governance-production-reference/grants/creategrant","metadata":{"seo":{"title":"Create a grant","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createGrant","name":"Create a grant","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1grants/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a grant","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a grant request with a specific grant type ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/grant-creatable","exampleIds":["paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal, with an expiration date","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant using a policy |tooltip| Grant using a policy","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements."]}},"schemaId":"components/schemas/grant-creatable","exampleIds":["paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal, with an expiration date","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant using a policy |tooltip| Grant using a policy","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements."],"pointer":"/paths/~1governance~1api~1v1~1grants/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grant request parameters depend on the selected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantType"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/grants","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/grant-creatable","exampleIds":["paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal, with an expiration date","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant using a policy |tooltip| Grant using a policy","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements."]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/grants","href":"grants/creategrant","openApiOperationId":"createGrant","summary":"Create a grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/grant-creatable","exampleIds":["paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal, with an expiration date","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant using a policy |tooltip| Grant using a policy","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements."],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/grant-creatable","exampleIds":["paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal, with an expiration date","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant using a policy |tooltip| Grant using a policy","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.","paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements."]}},"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 grant creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Entitlement grant with values"]}},"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Entitlement grant with values"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to create an entitlement bundle","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1grants/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Entitlement grant with values"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Entitlement grant with values"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/grants"},{"label":"List all grants","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/listgrants","routeSlug":"/iga/openapi/governance-production-reference/grants/listgrants","metadata":{"seo":{"title":"List all grants","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listGrants","name":"List all grants","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1grants/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all grants","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists active grants ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status=\"ACTIVE\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") for your org."},"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":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"?filter="},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is required."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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":" parameters are accepted. Standard "},"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 headers"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are in the response."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, results are sorted by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_1393","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/#pagination"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"pagination"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" cursor that points to the last record of the previous request"},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"filter","in":"query","schemaId":"schema_1394","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties:"},"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":"targetResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (alternatively, you can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific resource )"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetPrincipalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (alternatively, you can use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetPrincipal.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetPrincipal.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for a specific principal)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementBundleId"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlements.id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlements.values.id"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"action"},"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":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator is supported for these properties. 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 multiple expressions."},"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":[]}]}]}]}],"required":true,"examples":{"filterActiveGrants":{"summary":"Filter grants for a resource and user","value":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"filterActiveGrantsWithORN":{"summary":"Filter grants for a resource and user using ORNs","value":"targetResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\" AND targetPrincipalOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR\""},"filterActiveGrantsWithOnlyResource":{"summary":"Filter all grants for a resource using target resource ORN","value":"targetResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""},"filterGrantsWithEntitlementBundleId":{"summary":"Filter grants with resource and entitlement bundle","value":"targetResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\" AND entitlementBundleId eq \"enbllojq9J9J105DL1d6\""},"filterGrantsWithEntitlementValueId":{"summary":"Filter grants with resource and entitlement value ID","value":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\" AND entitlements.values.id eq \"entfxqCAJWWFTFUUYBBB\""},"filterGrantsWithEntitlementId":{"summary":"Filter grants with resource and entitlement ID","value":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\" AND entitlements.id eq \"espfxqCAJWWFTFUUYKKK\""},"filterGrantsWithMultipleBundleAndEntitlementValue":{"summary":"Filter grants with multiple entitlement value IDs and entitlment bundle ID","value":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\" AND (entitlements.values.id eq \"entfxqCAJWWFTFUUYBBB\" OR entitlements.values.id eq \"entfxqCAJWWFTFUUYXXX\" OR entitlementBundleId eq \"enbllojq9J9J105DL1d6\")"},"filterGrantsWithAction":{"summary":"Filter grants with resource and action","value":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\" AND action eq \"ALLOW\""}}},{"name":"include","in":"query","schemaId":"schema_1395","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter adds additional properties to the response."},"children":[]}]}]}],"examples":{"IncludeEntitlements":{"summary":"Include complete entitlements in the response","value":"full_entitlements"},"IncludeMetadata":{"summary":"Include metadata such as collection generating the grant in the response","value":"metadata"}}}],"pointer":"/paths/~1governance~1api~1v1~1grants/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/grants","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"after","in":"query","required":false,"schemaId":"components/schemas/id"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"filter","in":"query","required":true,"example":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\"","schemaId":"schema_1394"},{"name":"include","in":"query","required":false,"example":"full_entitlements","schemaId":"schema_1395"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/grants","href":"grants/listgrants","openApiOperationId":"listGrants","summary":"List all grants"},"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":"Get grants","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1396","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included"]}},"schemaId":"schema_1396","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to list grants","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When no target resource provided in filter |tooltip| When a request contains filter without a target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When no target resource provided in filter |tooltip| When a request contains filter without a target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1grants/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1396","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1396","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements","paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When no target resource provided in filter |tooltip| When a request contains filter without a target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When no target resource provided in filter |tooltip| When a request contains filter without a target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id","paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/grants"},{"label":"Retrieve a grant","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/getgrant","routeSlug":"/iga/openapi/governance-production-reference/grants/getgrant","metadata":{"seo":{"title":"Retrieve a grant","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getGrant","name":"Retrieve a grant","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a grant","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the full detail of a specific grant"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"grantId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the grant","required":true}],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_1395","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter adds additional properties to the response."},"children":[]}]}]}],"examples":{"IncludeEntitlements":{"summary":"Include complete entitlements in the response","value":"full_entitlements"},"IncludeMetadata":{"summary":"Include metadata such as collection generating the grant in the response","value":"metadata"}}}],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/grants/{grantId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"grantId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"include","in":"query","required":false,"example":"full_entitlements","schemaId":"schema_1395"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/grants/{grantId}","href":"grants/getgrant","openApiOperationId":"getGrant","summary":"Retrieve a grant"},"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":"Get grant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1397","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata"]}},"schemaId":"schema_1397","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"schema_1397","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1397","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements","paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/grants/{grantId}"},{"label":"Replace a grant","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/replacegrant","routeSlug":"/iga/openapi/governance-production-reference/grants/replacegrant","metadata":{"seo":{"title":"Replace a grant","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceGrant","name":"Replace a grant","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a grant","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces the entitlements of a grant with a specific "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"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":"You can only replace objects in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array for a grant with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CUSTOM"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This may result in changes to principal entitlements."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"grantId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the grant","required":true}],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody/content/application~1json/examples/Update custom grant entitlements |tooltip| Update custom grant entitlements."]}},"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody/content/application~1json/examples/Update custom grant entitlements |tooltip| Update custom grant entitlements."],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The grant request parameters depend on the selected "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantType"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v1/grants/{grantId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"grantId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody/content/application~1json/examples/Update custom grant entitlements |tooltip| Update custom grant entitlements."]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/grants/{grantId}","href":"grants/replacegrant","openApiOperationId":"replaceGrant","summary":"Replace a grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody/content/application~1json/examples/Update custom grant entitlements |tooltip| Update custom grant entitlements."],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody/content/application~1json/examples/Update custom grant entitlements |tooltip| Update custom grant entitlements."]}},"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 grant creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements"]}},"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to create an entitlement bundle","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/grants/{grantId}"},{"label":"Update a grant","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/grants/updategrant","routeSlug":"/iga/openapi/governance-production-reference/grants/updategrant","metadata":{"seo":{"title":"Update a grant","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateGrant","name":"Update a grant","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a grant","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a grant expiry date."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can only update the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"scheduleSettings.expirationDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property for a grant."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"grantId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the grant","required":true}],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/grant-patch","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date |tooltip| Update grant's expiration date.","paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone"]}},"schemaId":"components/schemas/grant-patch","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date |tooltip| Update grant's expiration date.","paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone"],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody","description":"Request parameters for a grant expiration date update"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/grants/{grantId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"grantId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/grant-patch","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date |tooltip| Update grant's expiration date.","paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/grants/{grantId}","href":"grants/updategrant","openApiOperationId":"updateGrant","summary":"Update a grant"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/grant-patch","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date |tooltip| Update grant's expiration date.","paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/grant-patch","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date |tooltip| Update grant's expiration date.","paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone"]}},"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 grant patch operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration"]}},"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"An invalid request to patch expiration date for grant","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/400/content/application~1json/examples/When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/400/content/application~1json/examples/When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found."]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/grant-full","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/400/content/application~1json/examples/When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/400/content/application~1json/examples/When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found."]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/grants/{grantId}"}],"content":{"contentType":"group","meta":{"name":"Grants"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Grants","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":"Grants represent an assignment or revocation of entitlements or entitlement bundles to a principal. A principal can have multiple grants."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grant types can have different behavior characteristics."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/grants","summary":"Create a grant","prefix":{"name":"post","color":"post"},"badges":[],"link":"/grants/creategrant","deprecated":false},{"title":"/governance/api/v1/grants","summary":"List all grants","prefix":{"name":"get","color":"get"},"badges":[],"link":"/grants/listgrants","deprecated":false},{"title":"/governance/api/v1/grants/{grantId}","summary":"Retrieve a grant","prefix":{"name":"get","color":"get"},"badges":[],"link":"/grants/getgrant","deprecated":false},{"title":"/governance/api/v1/grants/{grantId}","summary":"Replace a grant","prefix":{"name":"put","color":"put"},"badges":[],"link":"/grants/replacegrant","deprecated":false},{"title":"/governance/api/v1/grants/{grantId}","summary":"Update a grant","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/grants/updategrant","deprecated":false}]}]}]}]}},{"type":"group","label":"Principal Entitlements","link":"/iga/openapi/governance-production-reference/principal-entitlements","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements","items":[{"label":"Retrieve the principal's effective entitlements for a resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlements","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlements","metadata":{"seo":{"title":"Retrieve the principal's effective entitlements for a resource","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrincipalEntitlements","name":"Retrieve the principal's effective entitlements for a resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the principal's effective entitlements for a resource","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the principal's effective entitlements for a specific resource"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply various filters by using supported principal entitlements filtering properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"required":true,"examples":{"FilterByUserAndResource":{"summary":"Filter by user and application","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"FilterByUserAndResourceOrn":{"summary":"Filter by user and application ORNs","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\" AND targetPrincipalOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR\""}}}],"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/principal-entitlements","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\"","schemaId":"components/schemas/scim-filter"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/principal-entitlements","href":"principal-entitlements/getprincipalentitlements","openApiOperationId":"getPrincipalEntitlements","summary":"Retrieve the principal's effective entitlements for a resource"},"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":"List of all principal entitlements for a specific resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/200/content/application~1json/examples/Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce"]}},"schemaId":"components/schemas/principal-entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/200/content/application~1json/examples/Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid list request error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/principal-entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/200/content/application~1json/examples/Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-entitlements-list","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/200/content/application~1json/examples/Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/principal-entitlements"},{"label":"Retrieve the principal entitlement changes","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementschanges","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementschanges","metadata":{"seo":{"title":"Retrieve the principal entitlement changes","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrincipalEntitlementsChanges","name":"Retrieve the principal entitlement changes","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the principal entitlement changes","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the principal's old and new effective entitlement changes for a resource"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"principalEntitlementsChangeId","in":"path","schemaId":"schema_1398","description":"Unique identifier for the principal entitlements change. The entitlement change is Base64-encoded.","required":true}],"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/principal-entitlements-changes/{principalEntitlementsChangeId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"principalEntitlementsChangeId","in":"path","required":true,"example":"governance/api/v1/principal-entitlements-changes/cmVwMWtOQ2NmQnhhRWVEbXcwZzI6cmVwOHBCVVRWVG9na2lYNWUwZzI","schemaId":"schema_1398"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/principal-entitlements-changes/{principalEntitlementsChangeId}","href":"principal-entitlements/getprincipalentitlementschanges","openApiOperationId":"getPrincipalEntitlementsChanges","summary":"Retrieve the principal entitlement changes"},"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":"Return principal entitlement changes","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-entitlements-change","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/200/content/application~1json/examples/Principal entitlement changes"]}},"schemaId":"components/schemas/principal-entitlements-change","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/200/content/application~1json/examples/Principal entitlement changes"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/principal-entitlements-change","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/200/content/application~1json/examples/Principal entitlement changes"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-entitlements-change","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/200/content/application~1json/examples/Principal entitlement changes"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/principal-entitlements-changes/{principalEntitlementsChangeId}"},{"label":"Retrieve an entitlement history","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementshistory","routeSlug":"/iga/openapi/governance-production-reference/principal-entitlements/getprincipalentitlementshistory","metadata":{"seo":{"title":"Retrieve an entitlement history","description":"OAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrincipalEntitlementsHistory","name":"Retrieve an entitlement history","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an entitlement history","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an entitlement history log for a specific principal and resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the required principal and resource references in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can optionally specify a time range for the returned history log."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" 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":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and the following required and optional properties."},"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":"Required"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You must specify both principal and resource references with one of these sets of properties:"},"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":"principal.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.type"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceId"},"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":"Optional"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": You can optionally filter by a date range with the following properties:"},"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":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Start of the date range (inclusive) in ISO 8601 UTC format. If omitted, data is retrieved from the earliest available records."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"endDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": End of the date range (inclusive) in ISO 8601 UTC format. If omitted, data is retrieved up to the current time."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"required":true,"examples":{"FilterByUserAndResource":{"summary":"Filter by a principal user and an app resource","value":"resource.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"APPLICATION\" AND principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\""},"FilterByUserAndResourceOrn":{"summary":"Filter by a principal user and an app resource ORNs","value":"resourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\" AND principalOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR\""},"FilterWithOptionalStartDate":{"summary":"Filter by a principal user, an app, and a start date","value":"resource.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"APPLICATION\" AND principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\" AND startDate eq \"2024-01-01T00:00:00Z\""},"FilterWithOptionalEndDate":{"summary":"Filter by a principal user, an app, and an end date","value":"resource.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"APPLICATION\" AND principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\" AND endDate eq \"2024-12-31T23:59:59Z\""},"FilterWithDateRange":{"summary":"Filter by a principal user, an app, and a date range","value":"resource.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"APPLICATION\" AND principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\" AND startDate eq \"2024-01-01T00:00:00Z\" AND endDate eq \"2024-12-31T23:59:59Z\""},"FilterUsingOrnsWithDates":{"summary":"Filter by a principal user and an app ORNs with a date range","value":"resourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\" AND principalOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR\" AND startDate eq \"2024-01-01T00:00:00Z\" AND endDate eq \"2024-12-31T23:59:59Z\""},"FilterByPrincipalAndResourceIds":{"summary":"Filter by principal and resource IDs","value":"resourceId eq \"res503IOSVGTK5Jwx0g3\" AND principalId eq \"pri52knJhV4kPqp9j0g3\""}}},{"name":"limit","in":"query","schemaId":"schema_1399","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_1400","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An optional parameter that adds additional properties in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response object"},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/principal-entitlements/history","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"resource.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"APPLICATION\" AND principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1399"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"include","in":"query","required":false,"schemaId":"schema_1400"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/principal-entitlements/history","href":"principal-entitlements/getprincipalentitlementshistory","openApiOperationId":"getPrincipalEntitlementsHistory","summary":"Retrieve an entitlement history"},"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 principal entitlements history response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-entitlements-history","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/200/content/application~1json/examples/Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`"]}},"schemaId":"components/schemas/principal-entitlements-history","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/200/content/application~1json/examples/Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid list request error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/principal-entitlements-history","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/200/content/application~1json/examples/Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-entitlements-history","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/200/content/application~1json/examples/Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/principal-entitlements/history"}],"content":{"contentType":"group","meta":{"name":"Principal Entitlements"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Principal Entitlements","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":"Principal Entitlements represent the effective entitlements for a user and resource after evaluating all grants."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-entitlement-mgt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/principal-entitlements","summary":"Retrieve the principal's effective entitlements for a resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/principal-entitlements/getprincipalentitlements","deprecated":false},{"title":"/governance/api/v1/principal-entitlements-changes/{principalEntitlementsChangeId}","summary":"Retrieve the principal entitlement changes","prefix":{"name":"get","color":"get"},"badges":[],"link":"/principal-entitlements/getprincipalentitlementschanges","deprecated":false},{"title":"/governance/api/v1/principal-entitlements/history","summary":"Retrieve an entitlement history","prefix":{"name":"get","color":"get"},"badges":[],"link":"/principal-entitlements/getprincipalentitlementshistory","deprecated":false}]}]}]}]}},{"type":"group","label":"Principal Access","link":"/iga/openapi/governance-production-reference/principal-access","routeSlug":"/iga/openapi/governance-production-reference/principal-access","items":[{"label":"Retrieve the principal access for a resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-access/getprincipalaccess","routeSlug":"/iga/openapi/governance-production-reference/principal-access/getprincipalaccess","metadata":{"seo":{"title":"Retrieve the principal access for a resource","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getPrincipalAccess","name":"Retrieve the principal access for a resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1principal-access/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the principal access for a resource","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the current state of principal access for a specific resource. API shows if user has permanent or timed based access to the application along with what entitlements are assigned to that user."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Apply various filters by using supported principal access filtering properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"required":true,"examples":{"FilterByUserAndResource":{"summary":"Filter by user and application","value":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"FilterByUserAndResourceOrn":{"summary":"Filter by user and application ORNs","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\" AND targetPrincipalOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR\""}}}],"pointer":"/paths/~1governance~1api~1v1~1principal-access/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/principal-access","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\"","schemaId":"components/schemas/scim-filter"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/principal-access","href":"principal-access/getprincipalaccess","openApiOperationId":"getPrincipalAccess","summary":"Retrieve the principal access for a resource"},"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":"Principal access for a specific resource.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-access","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with no entitlements |tooltip| Principal access data with no entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata"]}},"schemaId":"components/schemas/principal-access","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with no entitlements |tooltip| Principal access data with no entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid list request error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1principal-access/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/principal-access","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with no entitlements |tooltip| Principal access data with no entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-access","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with no entitlements |tooltip| Principal access data with no entitlements","paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-access/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/principal-access"}],"content":{"contentType":"group","meta":{"name":"Principal Access"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Principal Access","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":"Principal Access represent a summary of user access for a resource"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-entitlement-mgt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for more information."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/principal-access","summary":"Retrieve the principal access for a resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/principal-access/getprincipalaccess","deprecated":false}]}]}]}]}},{"type":"group","label":"Principal Access - V2","link":"/iga/openapi/governance-production-reference/principal-access-v2","routeSlug":"/iga/openapi/governance-production-reference/principal-access-v2","items":[{"label":"Revoke a principal's access","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-access-v2/revokeprincipalaccess","routeSlug":"/iga/openapi/governance-production-reference/principal-access-v2/revokeprincipalaccess","metadata":{"seo":{"title":"Revoke a principal's access","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"revokePrincipalAccess","name":"Revoke a principal's access","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1revoke-principal-access/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke a principal's access","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Revokes a principal's access to resources (entitlement values, entitlement bundles, or apps)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns 200 OK HTTP code after access is revoked with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to updated resources."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/revoke-principal-access-creatable","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to a single app","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement values","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement bundles","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to entitlement values and bundles"]}},"schemaId":"components/schemas/revoke-principal-access-creatable","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to a single app","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement values","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement bundles","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to entitlement values and bundles"],"pointer":"/paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody","description":"The revocation request parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/revoke-principal-access","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/revoke-principal-access-creatable","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to a single app","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement values","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement bundles","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to entitlement values and bundles"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/revoke-principal-access","href":"principal-access-v2/revokeprincipalaccess","openApiOperationId":"revokePrincipalAccess","summary":"Revoke a principal's access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/revoke-principal-access-creatable","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to a single app","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement values","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement bundles","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to entitlement values and bundles"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/revoke-principal-access-creatable","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to a single app","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement values","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement bundles","paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to entitlement values and bundles"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response for a successful revocation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/revoke-principal-access-response","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/200/content/application~1json/examples/Successful revocation response"]}},"schemaId":"components/schemas/revoke-principal-access-response","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/200/content/application~1json/examples/Successful revocation response"]},{"code":"400","description":"Bad request - invalid revocation parameters","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Missing required field","paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Invalid ORN format"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Missing required field","paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Invalid ORN format"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1revoke-principal-access/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/revoke-principal-access-response","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/200/content/application~1json/examples/Successful revocation response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/revoke-principal-access-response","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/200/content/application~1json/examples/Successful revocation response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Missing required field","paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Invalid ORN format"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Missing required field","paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Invalid ORN format"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/revoke-principal-access"}],"content":{"contentType":"group","meta":{"name":"Principal Access - V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Principal Access - V2","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 Principal Access - V2 API allows you to manage principals' access to resources. You must have entitlement management enabled on the resources to govern principal access. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=ext-entitlement-mgt"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement Management"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v2/revoke-principal-access","summary":"Revoke a principal's access","prefix":{"name":"post","color":"post"},"badges":[],"link":"/principal-access-v2/revokeprincipalaccess","deprecated":false}]}]}]}]}},{"type":"group","label":"Collections","link":"/iga/openapi/governance-production-reference/collections","routeSlug":"/iga/openapi/governance-production-reference/collections","items":[{"label":"Create a resource collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/createcollection","routeSlug":"/iga/openapi/governance-production-reference/collections/createcollection","metadata":{"seo":{"title":"Create a resource collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCollection","name":"Create a resource collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a resource collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an empty resource collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v1~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"]}},"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v1~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"],"pointer":"/paths/~1governance~1api~1v1~1collections/post/requestBody","description":"The writeable attributes of a resource collection"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/collections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v1~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/collections","href":"collections/createcollection","openApiOperationId":"createCollection","summary":"Create a resource collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v1~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v1~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Response to a successful resource collection creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}},"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections"},{"label":"List all resource collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollections","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollections","metadata":{"seo":{"title":"List all resource collections","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollections","name":"List all resource collections","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all resource collections","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all resource collections"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_1401","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter adds additional properties in the response."},"children":[]}]}]}],"examples":{"IncludeCounts":{"summary":"Include resource counts and assignment counts in the response","value":"counts"}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_1402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters data based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource collection properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operators"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator is supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"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":" Query parameter percent encoding is required. See "},"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":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"searchCollectionsByName":{"summary":"Search for resource collections with a name that begins with \"Sales\"","value":"name sw \"Sales\""},"searchCollectionsByNameContains":{"summary":"Search for resource collections with a name that contains \"Sales\"","value":"name co \"Sales\""},"searchCollectionsById":{"summary":"Search for resource collections with specific IDs","value":"id eq \"coljqM9a9xerZfRpp0g2\" or id eq \"coljrNAph4LiA2C1m0g2\""}}}],"pointer":"/paths/~1governance~1api~1v1~1collections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/collections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"include","in":"query","required":false,"example":"counts","schemaId":"schema_1401"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"filter","in":"query","required":false,"example":"name sw \"Sales\"","schemaId":"schema_1402"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/collections","href":"collections/listcollections","openApiOperationId":"listCollections","summary":"List all resource collections"},"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 collection list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collections-list","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list with counts |tooltip| List of collections with counts"]}},"schemaId":"components/schemas/collections-list","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list with counts |tooltip| List of collections with counts"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collections-list","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list with counts |tooltip| List of collections with counts"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collections-list","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list with counts |tooltip| List of collections with counts"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections"},{"label":"Retrieve a resource collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/getcollection","routeSlug":"/iga/openapi/governance-production-reference/collections/getcollection","metadata":{"seo":{"title":"Retrieve a resource collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCollection","name":"Retrieve a resource collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a resource collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a resource collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/collections/{collectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}","href":"collections/getcollection","openApiOperationId":"getCollection","summary":"Retrieve a resource collection"},"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":"Response to a successful resource collection creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}},"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}"},{"label":"Replace a resource collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/replacecollection","routeSlug":"/iga/openapi/governance-production-reference/collections/replacecollection","metadata":{"seo":{"title":"Replace a resource collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceCollection","name":"Replace a resource collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a resource collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces a resource collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"]}},"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody","description":"The writeable attributes of a resource collection"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v1/collections/{collectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}","href":"collections/replacecollection","openApiOperationId":"replaceCollection","summary":"Replace a resource collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to a successful resource collection creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}},"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}"},{"label":"Delete a collection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/deletecollection","routeSlug":"/iga/openapi/governance-production-reference/collections/deletecollection","metadata":{"seo":{"title":"Delete a collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCollection","name":"Delete a collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a collection","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.governance.collections.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":"APP_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 collection specified by an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/collections/{collectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}","href":"collections/deletecollection","openApiOperationId":"deleteCollection","summary":"Delete a collection"},"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":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}"},{"label":"List all collection resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollectionresources","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollectionresources","metadata":{"seo":{"title":"List all collection resources","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionResources","name":"List all collection resources","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all collection resources","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all the resources in a given collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_1403","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter returns additional properties in the response."},"children":[]}]}]}],"example":"entitlements"},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/collections/{collectionId}/resources","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"include","in":"query","required":false,"example":"entitlements","schemaId":"schema_1403"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/resources","href":"collections/listcollectionresources","openApiOperationId":"listCollectionResources","summary":"List all collection resources"},"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 collection resources list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info"]}},"schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info","paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/resources"},{"label":"Add the resources to a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/addresourcestocollection","routeSlug":"/iga/openapi/governance-production-reference/collections/addresourcestocollection","metadata":{"seo":{"title":"Add the resources to a collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addResourcesToCollection","name":"Add the resources to a collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add the resources to a collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds the resources to a collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1404","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/example"]}},"schemaId":"schema_1404","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/example"],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/collections/{collectionId}/resources","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1404","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/resources","href":"collections/addresourcestocollection","openApiOperationId":"addResourcesToCollection","summary":"Add the resources to a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1404","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1404","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/example"]}},"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 add resources to collection list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection"]}},"schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"The response to an invalid request to add resources to a collection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/resources"},{"label":"Delete a collection resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/deletecollectionresource","routeSlug":"/iga/openapi/governance-production-reference/collections/deletecollectionresource","metadata":{"seo":{"title":"Delete a collection resource","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCollectionResource","name":"Delete a collection resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a collection resource","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a specified resource from a collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"resourceId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","href":"collections/deletecollectionresource","openApiOperationId":"deleteCollectionResource","summary":"Delete a collection resource"},"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":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}"},{"label":"Retrieve a collection resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/getcollectionresource","routeSlug":"/iga/openapi/governance-production-reference/collections/getcollectionresource","metadata":{"seo":{"title":"Retrieve a collection resource","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCollectionResource","name":"Retrieve a collection resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a collection resource","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a collection resource with entitlements"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"resourceId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","href":"collections/getcollectionresource","openApiOperationId":"getCollectionResource","summary":"Retrieve a collection resource"},"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":"Response to a successful get resource collection operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/example"]},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}"},{"label":"Replace a collection resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/replacecollectionresource","routeSlug":"/iga/openapi/governance-production-reference/collections/replacecollectionresource","metadata":{"seo":{"title":"Replace a collection resource","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceCollectionResource","name":"Replace a collection resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a collection resource","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces a specified resource in a collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody","description":"The updatable attributes of a collection resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"resourceId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","href":"collections/replacecollectionresource","openApiOperationId":"replaceCollectionResource","summary":"Replace a collection resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to a successful collection resource update operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/example"]}},"schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/example"]},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-full","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/example"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}"},{"label":"Retrieve the unassigned users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/getunassignedusers","routeSlug":"/iga/openapi/governance-production-reference/collections/getunassignedusers","metadata":{"seo":{"title":"Retrieve the unassigned users","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUnassignedUsers","name":"Retrieve the unassigned users","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the unassigned users","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves unassigned users for a collection based on the provided filter"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters users based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for these properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"searchWithFirstName":{"summary":"Search for unassigned users with a first name that begins with \"John\"","value":"firstName sw \"John\""},"searchWithName":{"summary":"Search for unassigned users with a first name, last name, or email that begins with \"John\"","value":"firstName sw \"John\" OR lastName sw \"John\" OR email sw \"John\""}}}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/collections/{collectionId}/catalog/users","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"filter","in":"query","required":false,"example":"firstName sw \"John\"","schemaId":"components/schemas/scim-filter"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/catalog/users","href":"collections/getunassignedusers","openApiOperationId":"getUnassignedUsers","summary":"Retrieve the unassigned users"},"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 users that can be assigned to a collection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"]}},"schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/catalog/users"},{"label":"List all assignments for a collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollectionassignments","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollectionassignments","metadata":{"seo":{"title":"List all assignments for a collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionAssignments","name":"List all assignments for a collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all assignments for a collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all assignments for a collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignments for a collection are sorted by last assigned principals first."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters principals based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for these properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":{"isPrincipalAssigned":{"summary":"Search for principal assignment with specific properties","value":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\""},"searchWithName":{"summary":"Search for assigned principals with a name that begins with \"John\"","value":"principalProfile.name sw \"John\""}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/collections/{collectionId}/assignments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"filter","in":"query","required":false,"example":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/assignments","href":"collections/listcollectionassignments","openApiOperationId":"listCollectionAssignments","summary":"List all assignments for a collection"},"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 list of assigned principals response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}},"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments"},{"label":"Assign a collection to principals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/assigncollection","routeSlug":"/iga/openapi/governance-production-reference/collections/assigncollection","metadata":{"seo":{"title":"Assign a collection to principals","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignCollection","name":"Assign a collection to principals","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign a collection to principals","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigns a collection to principals"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assignment can be for a limited time or indefinite. This operation is idempotent. If the assignment already exists, it will be updated with the new values."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."]}},"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody","description":"Attributes of collection assignment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/collections/{collectionId}/assignments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/assignments","href":"collections/assigncollection","openApiOperationId":"assignCollection","summary":"Assign a collection to principals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A list of assigned principals","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"]}},"schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments"},{"label":"Update a principal assignment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/updateprincipalassignment","routeSlug":"/iga/openapi/governance-production-reference/collections/updateprincipalassignment","metadata":{"seo":{"title":"Update a principal assignment","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePrincipalAssignment","name":"Update a principal assignment","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a principal assignment","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a principal assignment"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"assignmentId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection assignment","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"]}},"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody","description":"The writable attributes of a collection assignment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"assignmentId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"]}},"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}","href":"collections/updateprincipalassignment","openApiOperationId":"updatePrincipalAssignment","summary":"Update a principal assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}"},{"label":"Delete a principal assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/deleteprincipalassignment","routeSlug":"/iga/openapi/governance-production-reference/collections/deleteprincipalassignment","metadata":{"seo":{"title":"Delete a principal assignment","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePrincipalAssignment","name":"Delete a principal assignment","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a principal assignment","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes principal assignment"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"assignmentId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection assignment","required":true}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"assignmentId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","401","403","429","500"],"pointer":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}","href":"collections/deleteprincipalassignment","openApiOperationId":"deletePrincipalAssignment","summary":"Delete a principal assignment"},"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":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}"},{"label":"List all assignments for all collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections/listcollectionsassignments","routeSlug":"/iga/openapi/governance-production-reference/collections/listcollectionsassignments","metadata":{"seo":{"title":"List all assignments for all collections","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionsAssignments","name":"List all assignments for all collections","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1collections~1assignments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all assignments for all collections","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists assignments for all collections"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignments for all collections are sorted by last assigned principals first."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters principals based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for these properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":{"isPrincipalAssigned":{"summary":"Search for principal assignment with specific properties","value":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\""},"searchWithName":{"summary":"Search for assigned principals with a name that begins with \"John\"","value":"principalProfile.name sw \"John\""}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1assignments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/collections/assignments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/collections/assignments","href":"collections/listcollectionsassignments","openApiOperationId":"listCollectionsAssignments","summary":"List all assignments for all collections"},"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 list of assigned principals response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}},"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1collections~1assignments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1collections~1assignments/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/collections/assignments"}],"content":{"contentType":"group","meta":{"name":"Collections"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collections","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 Collections API allows you to manage resource collections that contain apps and entitlements. Apps must opt in to Entitlement Management (EM) before they can be added to a collection."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can directly assign resource collections to users (principals) or create access request conditions to streamline access to collections. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=csh-rc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product documentation."},"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":"Notes:"},"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":"For non-EM apps, groups, and push group support in collections, use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/iga/openapi/governance-production-reference/collections-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections - V2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" APIs."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extend resource collections with Okta groups, Okta push groups, and non-Entitlement Management apps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature in your org (see "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?id=ext_Manage_Early_Access_features"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Early Access and Beta features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), you must use the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/iga/openapi/governance-production-reference/collections-v2"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections - V2"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API instead of the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/iga/openapi/governance-production-reference/collections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API. With this feature enabled, certain method requests to the original "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/iga/openapi/governance-production-reference/collections"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Collections"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" API may return unexpected responses. Nevertheless, collections managed through either version of the API can still be used within access certification campaigns or access requests."},"children":[]}]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/collections","summary":"Create a resource collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/createcollection","deprecated":false},{"title":"/governance/api/v1/collections","summary":"List all resource collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/listcollections","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}","summary":"Retrieve a resource collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/getcollection","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}","summary":"Replace a resource collection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/collections/replacecollection","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}","summary":"Delete a collection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collections/deletecollection","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/resources","summary":"List all collection resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/listcollectionresources","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/resources","summary":"Add the resources to a collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/addresourcestocollection","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","summary":"Delete a collection resource","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collections/deletecollectionresource","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","summary":"Retrieve a collection resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/getcollectionresource","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/resources/{resourceId}","summary":"Replace a collection resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/collections/replacecollectionresource","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/catalog/users","summary":"Retrieve the unassigned users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/getunassignedusers","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/assignments","summary":"List all assignments for a collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/listcollectionassignments","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/assignments","summary":"Assign a collection to principals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections/assigncollection","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}","summary":"Update a principal assignment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/collections/updateprincipalassignment","deprecated":false},{"title":"/governance/api/v1/collections/{collectionId}/assignments/{assignmentId}","summary":"Delete a principal assignment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collections/deleteprincipalassignment","deprecated":false},{"title":"/governance/api/v1/collections/assignments","summary":"List all assignments for all collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections/listcollectionsassignments","deprecated":false}]}]}]}]}},{"type":"group","label":"Collections - V2","link":"/iga/openapi/governance-production-reference/collections-v2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2","items":[{"label":"Create a resource collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/createcollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/createcollectionv2","metadata":{"seo":{"title":"Create a resource collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createCollectionV2","name":"Create a resource collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a resource collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates an empty resource collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v2~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"]}},"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v2~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"],"pointer":"/paths/~1governance~1api~1v2~1collections/post/requestBody","description":"The writeable attributes of a resource collection"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/collections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v2~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v2/collections","href":"collections-v2/createcollectionv2","openApiOperationId":"createCollectionV2","summary":"Create a resource collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v2~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-creatable","exampleIds":["paths/~1governance~1api~1v2~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Response to a successful resource collection creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}},"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections"},{"label":"List all resource collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsv2","metadata":{"seo":{"title":"List all resource collections","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionsV2","name":"List all resource collections","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all resource collections","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all resource collections"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_1401","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter adds additional properties in the response."},"children":[]}]}]}],"examples":{"IncludeCounts":{"summary":"Include resource counts and assignment counts in the response","value":"counts"}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_1402","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters data based on "},"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":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource collection properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operators"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are supported for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator is supported for "},"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":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalOrn"},"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 filtering by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Okta returns only collections that contain the specified resource."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each collection in the response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceRelationship"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with details about when the resource was added."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When filtering by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", Okta returns only collections assigned to the specified principal."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Each collection in the response includes a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalAssignment"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object with assignment details."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"searchCollectionsByName":{"summary":"Search for resource collections with a name that begins with \"Sales\"","value":"name sw \"Sales\""},"searchCollectionsByNameContains":{"summary":"Search for resource collections with a name that contains \"Sales\"","value":"name co \"Sales\""},"searchCollectionsById":{"summary":"Search for resource collections with specific IDs","value":"id eq \"coljqM9a9xerZfRpp0g2\" or id eq \"coljrNAph4LiA2C1m0g2\""},"filterByResourceOrn":{"summary":"Find collections that contain a specific resource","value":"resourceOrn eq \"orn:okta:idp:00o1234567890:apps:0oa1234567890\""},"filterByPrincipalOrn":{"summary":"Find collections assigned to a specific principal","value":"principalOrn eq \"orn:okta:idp:00o1234567890:users:00u1234567890\""}}}],"pointer":"/paths/~1governance~1api~1v2~1collections/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"include","in":"query","required":false,"example":"counts","schemaId":"schema_1401"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"filter","in":"query","required":false,"example":"name sw \"Sales\"","schemaId":"schema_1402"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections","href":"collections-v2/listcollectionsv2","openApiOperationId":"listCollectionsV2","summary":"List all resource collections"},"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 collection list response (v2)","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collections-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details"]}},"schemaId":"components/schemas/collections-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collections-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collections-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details","paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections"},{"label":"Retrieve a resource collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/getcollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/getcollectionv2","metadata":{"seo":{"title":"Retrieve a resource collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCollectionV2","name":"Retrieve a resource collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a resource collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a resource collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections/{collectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}","href":"collections-v2/getcollectionv2","openApiOperationId":"getCollectionV2","summary":"Retrieve a resource collection"},"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":"Response to a successful resource collection creation operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}},"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}"},{"label":"Replace a resource collection","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionv2","metadata":{"seo":{"title":"Replace a resource collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceCollectionV2","name":"Replace a resource collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a resource collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces a resource collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"]}},"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody","description":"The writeable attributes of a resource collection"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v2/collections/{collectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}","href":"collections-v2/replacecollectionv2","openApiOperationId":"replaceCollectionV2","summary":"Replace a resource collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to a successful resource collection replace operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}},"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}"},{"label":"Delete a collection","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionv2","metadata":{"seo":{"title":"Delete a collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCollectionV2","name":"Delete a collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a collection","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.governance.collections.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":"APP_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 collection specified by an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v2/collections/{collectionId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}","href":"collections-v2/deletecollectionv2","openApiOperationId":"deleteCollectionV2","summary":"Delete a collection"},"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":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}"},{"label":"List all collection resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourcesv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourcesv2","metadata":{"seo":{"title":"List all collection resources","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionResourcesV2","name":"List all collection resources","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all collection resources","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all the resources in a given collection. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to return additional properties such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"counts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_1406","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter returns additional properties in the response."},"children":[]}]}]}],"example":"counts"},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections/{collectionId}/resources","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"include","in":"query","required":false,"example":"counts","schemaId":"schema_1406"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/resources","href":"collections-v2/listcollectionresourcesv2","openApiOperationId":"listCollectionResourcesV2","summary":"List all collection resources"},"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 collection resources list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter."]}},"schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter."],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter."]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/resources"},{"label":"Add the resources to a collection","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/addresourcestocollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/addresourcestocollectionv2","metadata":{"seo":{"title":"Add the resources to a collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addResourcesToCollectionV2","name":"Add the resources to a collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add the resources to a collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds the resources to a collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1407","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add apps with entitlements and apps with push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add groups and push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection"]}},"schemaId":"schema_1407","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add apps with entitlements and apps with push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add groups and push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection"],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/collections/{collectionId}/resources","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"schema_1407","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add apps with entitlements and apps with push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add groups and push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/resources","href":"collections-v2/addresourcestocollectionv2","openApiOperationId":"addResourcesToCollectionV2","summary":"Add the resources to a collection"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"schema_1407","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add apps with entitlements and apps with push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add groups and push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1407","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add apps with entitlements and apps with push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add groups and push groups to a collection","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection"]}},"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 add resources to collection list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection"]}},"schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"The response to an invalid request to add resources to a collection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resources-list-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/resources"},{"label":"Delete a collection resource","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionresourcev2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/deletecollectionresourcev2","metadata":{"seo":{"title":"Delete a collection resource","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteCollectionResourceV2","name":"Delete a collection resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a collection resource","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a specified resource from a collection"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"resourceId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","href":"collections-v2/deletecollectionresourcev2","openApiOperationId":"deleteCollectionResourceV2","summary":"Delete a collection resource"},"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":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}"},{"label":"Retrieve a collection resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/getcollectionresourcev2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/getcollectionresourcev2","metadata":{"seo":{"title":"Retrieve a collection resource","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getCollectionResourceV2","name":"Retrieve a collection resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a collection resource","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a collection resource with its details. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to return additional properties such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"relatedApps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include","in":"query","schemaId":"schema_1408","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":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter returns additional properties in the response."},"children":[]}]}]}],"example":"labels"}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"resourceId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"include","in":"query","required":false,"example":"labels","schemaId":"schema_1408"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","href":"collections-v2/getcollectionresourcev2","openApiOperationId":"getCollectionResourceV2","summary":"Retrieve a collection resource"},"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":"Response to a successful get resource collection operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups |tooltip| Response showing an app resource with push groups","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group |tooltip| Response showing a push group resource","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)"]}},"schemaId":"components/schemas/collection-resource-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups |tooltip| Response showing an app resource with push groups","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group |tooltip| Response showing a push group resource","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)"]},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resource-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups |tooltip| Response showing an app resource with push groups","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group |tooltip| Response showing a push group resource","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-full-v2","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups |tooltip| Response showing an app resource with push groups","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group |tooltip| Response showing a push group resource","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)","paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}"},{"label":"Replace a collection resource","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionresourcev2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/replacecollectionresourcev2","metadata":{"seo":{"title":"Replace a collection resource","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceCollectionResourceV2","name":"Replace a collection resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a collection resource","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces entitlements for an Entitlement Management (EM) enabled app resource in a collection. Only supports resources with type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that have Entitlement Management enabled."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"]}},"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody","description":"The updatable attributes of a collection resource"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"resourceId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","href":"collections-v2/replacecollectionresourcev2","openApiOperationId":"replaceCollectionResourceV2","summary":"Replace a collection resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/collection-resource-updatable","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Response to a successful collection resource update operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-app-with-entitlements","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements"]}},"schemaId":"components/schemas/collection-resource-app-with-entitlements","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements"]},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resource-app-with-entitlements","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-app-with-entitlements","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}"},{"label":"List all entitlements for a collection resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourceentitlementsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionresourceentitlementsv2","metadata":{"seo":{"title":"List all entitlements for a collection resource","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionResourceEntitlementsV2","name":"List all entitlements for a collection resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all entitlements for a collection resource","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all entitlements for an Entitlement Management (EM) enabled app resource in a collection. This method is only supported for resources with type "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that have Entitlement Management enabled."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"resourceId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the resource","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}/entitlements","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"resourceId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}/entitlements","href":"collections-v2/listcollectionresourceentitlementsv2","openApiOperationId":"listCollectionResourceEntitlementsV2","summary":"List all entitlements for a collection resource"},"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 collection resource entitlements list response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-entitlements-list","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/200/content/application~1json/examples/List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection"]}},"schemaId":"components/schemas/collection-resource-entitlements-list","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/200/content/application~1json/examples/List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/collection-resource-entitlements-list","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/200/content/application~1json/examples/List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/collection-resource-entitlements-list","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/200/content/application~1json/examples/List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}/entitlements"},{"label":"Retrieve the unassigned users","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/getunassignedusersv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/getunassignedusersv2","metadata":{"seo":{"title":"Retrieve the unassigned users","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getUnassignedUsersV2","name":"Retrieve the unassigned users","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the unassigned users","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves unassigned users for a collection based on the provided filter"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters users based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"firstName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastName"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"email"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for these properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"searchWithFirstName":{"summary":"Search for unassigned users with a first name that begins with \"John\"","value":"firstName sw \"John\""},"searchWithName":{"summary":"Search for unassigned users with a first name, last name, or email that begins with \"John\"","value":"firstName sw \"John\" OR lastName sw \"John\" OR email sw \"John\""}}}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections/{collectionId}/catalog/users","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"filter","in":"query","required":false,"example":"firstName sw \"John\"","schemaId":"components/schemas/scim-filter"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/catalog/users","href":"collections-v2/getunassignedusersv2","openApiOperationId":"getUnassignedUsersV2","summary":"Retrieve the unassigned users"},"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 users that can be assigned to a collection","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"]}},"schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-catalog-users","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/catalog/users"},{"label":"List all assignments for a collection","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionassignmentsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionassignmentsv2","metadata":{"seo":{"title":"List all assignments for a collection","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionAssignmentsV2","name":"List all assignments for a collection","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all assignments for a collection","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all assignments for a collection"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignments for a collection are sorted by last assigned principals first."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters principals based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for these properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":{"isPrincipalAssigned":{"summary":"Search for principal assignment with specific properties","value":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\""},"searchWithName":{"summary":"Search for assigned principals with a name that begins with \"John\"","value":"principalProfile.name sw \"John\""}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections/{collectionId}/assignments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"filter","in":"query","required":false,"example":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/assignments","href":"collections-v2/listcollectionassignmentsv2","openApiOperationId":"listCollectionAssignmentsV2","summary":"List all assignments for a collection"},"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 list of assigned principals response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}},"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments"},{"label":"Assign a collection to principals","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/assigncollectionv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/assigncollectionv2","metadata":{"seo":{"title":"Assign a collection to principals","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignCollectionV2","name":"Assign a collection to principals","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign a collection to principals","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assigns a collection to principals"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assignment can be for a limited time or indefinite. This operation is idempotent. If the assignment already exists, it's updated with the new values."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."]}},"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody","description":"Attributes of collection assignment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/collections/{collectionId}/assignments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/assignments","href":"collections-v2/assigncollectionv2","openApiOperationId":"assignCollectionV2","summary":"Assign a collection to principals"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/add-principals-to-collection","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A list of assigned principals","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"]}},"schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_1405","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments"},{"label":"Update a principal assignment","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/updateprincipalassignmentv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/updateprincipalassignmentv2","metadata":{"seo":{"title":"Update a principal assignment","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePrincipalAssignmentV2","name":"Update a principal assignment","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a principal assignment","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a principal assignment"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"assignmentId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection assignment","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"]}},"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody","description":"The writable attributes of a collection assignment"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"assignmentId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"]}},"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}","href":"collections-v2/updateprincipalassignmentv2","openApiOperationId":"updatePrincipalAssignmentV2","summary":"Update a principal assignment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assignment-patch","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"]}},"examples":[{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}"},{"label":"Delete a principal assignment","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/deleteprincipalassignmentv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/deleteprincipalassignmentv2","metadata":{"seo":{"title":"Delete a principal assignment","description":"BetaOAuth 2.0 scope:okta.governance.collections.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deletePrincipalAssignmentV2","name":"Delete a principal assignment","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a principal assignment","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a principal assignment"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"collectionId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection","required":true},{"name":"assignmentId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the collection assignment","required":true}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"collectionId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"assignmentId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","401","403","429","500"],"pointer":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}","href":"collections-v2/deleteprincipalassignmentv2","openApiOperationId":"deletePrincipalAssignmentV2","summary":"Delete a principal assignment"},"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":"A successful collection response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}"},{"label":"List all assignments for all collections","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsassignmentsv2","routeSlug":"/iga/openapi/governance-production-reference/collections-v2/listcollectionsassignmentsv2","metadata":{"seo":{"title":"List all assignments for all collections","description":"BetaOAuth 2.0 scope:okta.governance.collections.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listCollectionsAssignmentsV2","name":"List all assignments for all collections","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1collections~1assignments/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all assignments for all collections","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.governance.collections.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists assignments for all collections"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Assignments for all collections are sorted by last assigned principals first."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters principals based on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalProfile"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operator"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported for these properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"examples":{"isPrincipalAssigned":{"summary":"Search for principal assignment with specific properties","value":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\""},"searchWithName":{"summary":"Search for assigned principals with a name that begins with \"John\"","value":"principalProfile.name sw \"John\""}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1assignments/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/collections/assignments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"principal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND principal.type eq \"OKTA_USER\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/collections/assignments","href":"collections-v2/listcollectionsassignmentsv2","openApiOperationId":"listCollectionsAssignmentsV2","summary":"List all assignments for all collections"},"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 list of assigned principals response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}},"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1collections~1assignments/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-assigned-principals","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1collections~1assignments/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/collections/assignments"}],"content":{"contentType":"group","meta":{"name":"Collections - V2"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Collections - V2","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 Collections - V2 API allows you to manage collections of resources, such as apps, groups, and push groups. Apps included in the collection can opt in or out of Entitlement Management (EM). You can directly assign resource collections to users (principals) or create access request conditions to streamline access to collections. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=csh-rc"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource collection"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the product documentation."},"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 must enable the "},"children":[]},{"$$mdtype":"Node","type":"strong","inline":true,"attributes":{"marker":"**"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Extend resource collections with Okta groups, Okta push groups, and non-Entitlement Management apps"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" feature to use the Collections - V2 APIs. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?id=ext_Manage_Early_Access_features"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Manage Early Access and Beta features"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v2/collections","summary":"Create a resource collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections-v2/createcollectionv2","deprecated":false},{"title":"/governance/api/v2/collections","summary":"List all resource collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/listcollectionsv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}","summary":"Retrieve a resource collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/getcollectionv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}","summary":"Replace a resource collection","prefix":{"name":"put","color":"put"},"badges":[],"link":"/collections-v2/replacecollectionv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}","summary":"Delete a collection","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collections-v2/deletecollectionv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/resources","summary":"List all collection resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/listcollectionresourcesv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/resources","summary":"Add the resources to a collection","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections-v2/addresourcestocollectionv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","summary":"Delete a collection resource","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collections-v2/deletecollectionresourcev2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","summary":"Retrieve a collection resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/getcollectionresourcev2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}","summary":"Replace a collection resource","prefix":{"name":"put","color":"put"},"badges":[],"link":"/collections-v2/replacecollectionresourcev2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/resources/{resourceId}/entitlements","summary":"List all entitlements for a collection resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/listcollectionresourceentitlementsv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/catalog/users","summary":"Retrieve the unassigned users","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/getunassignedusersv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/assignments","summary":"List all assignments for a collection","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/listcollectionassignmentsv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/assignments","summary":"Assign a collection to principals","prefix":{"name":"post","color":"post"},"badges":[],"link":"/collections-v2/assigncollectionv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}","summary":"Update a principal assignment","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/collections-v2/updateprincipalassignmentv2","deprecated":false},{"title":"/governance/api/v2/collections/{collectionId}/assignments/{assignmentId}","summary":"Delete a principal assignment","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/collections-v2/deleteprincipalassignmentv2","deprecated":false},{"title":"/governance/api/v2/collections/assignments","summary":"List all assignments for all collections","prefix":{"name":"get","color":"get"},"badges":[],"link":"/collections-v2/listcollectionsassignmentsv2","deprecated":false}]}]}]}]}},{"type":"group","label":"Risk Rules","link":"/iga/openapi/governance-production-reference/risk-rules","routeSlug":"/iga/openapi/governance-production-reference/risk-rules","items":[{"label":"Create a risk rule","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/createriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/createriskrule","metadata":{"seo":{"title":"Create a risk rule","description":"BetaOAuth 2.0 scope:okta.governance.riskRule.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createRiskRule","name":"Create a risk rule","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1risk-rules/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a risk rule","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.governance.riskRule.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a risk rule"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/requestBody/content/application~1json/examples/Create risk rule request"]}},"schemaId":"components/schemas/create-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/requestBody/content/application~1json/examples/Create risk rule request"],"pointer":"/paths/~1governance~1api~1v1~1risk-rules/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/risk-rules","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/create-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/requestBody/content/application~1json/examples/Create risk rule request"]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/risk-rules","href":"risk-rules/createriskrule","openApiOperationId":"createRiskRule","summary":"Create a risk rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/create-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/requestBody/content/application~1json/examples/Create risk rule request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/create-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/requestBody/content/application~1json/examples/Create risk rule request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Risk rule success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/201/content/application~1json/examples/Risk rule response"]}},"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/201/content/application~1json/examples/Risk rule response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"The response to add a rule with a duplicate name","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/400/content/application~1json/examples/duplicateName"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/400/content/application~1json/examples/duplicateName"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/201/content/application~1json/examples/Risk rule response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/201/content/application~1json/examples/Risk rule response"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/400/content/application~1json/examples/duplicateName"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/400/content/application~1json/examples/duplicateName"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/risk-rules"},{"label":"List all risk rules","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/listriskrules","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/listriskrules","metadata":{"seo":{"title":"List all risk rules","description":"BetaOAuth 2.0 scope:okta.governance.riskRule.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listRiskRules","name":"List all risk rules","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1risk-rules/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all risk rules","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.governance.riskRule.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all risk rules"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"filter","in":"query","schemaId":"schema_1409","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A filter expression that returns entries based on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties and 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":"resourceOrn"},"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":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"name"},"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":" 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":[]}]}]}]}],"examples":{"searchRiskRuleByName":{"summary":"Search for risk rules with a name that begins with \"Process\"","value":"name sw \"Process\""},"searchRiskRuleByNameContains":{"summary":"Search for risk rules with a name that contains \"Process\"","value":"name co \"Process\""},"searchByResourceOrn":{"summary":"Search for risk rules with a specific resource ORN","value":"resourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""}}}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/risk-rules","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"filter","in":"query","example":"name sw \"Process\"","schemaId":"schema_1409"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/risk-rules","href":"risk-rules/listriskrules","openApiOperationId":"listRiskRules","summary":"List all risk rules"},"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":"Risk rules retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/200/content/application~1json/examples/List risk rule response"]}},"schemaId":"components/schemas/list-risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/200/content/application~1json/examples/List risk rule response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/200/content/application~1json/examples/List risk rule response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/200/content/application~1json/examples/List risk rule response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/risk-rules"},{"label":"Retrieve a risk rule","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/getriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/getriskrule","metadata":{"seo":{"title":"Retrieve a risk rule","description":"BetaOAuth 2.0 scope:okta.governance.riskRule.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getRiskRule","name":"Retrieve a risk rule","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a risk rule","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.governance.riskRule.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a risk rule"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ruleId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the risk rule","required":true}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/risk-rules/{ruleId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/risk-rules/{ruleId}","href":"risk-rules/getriskrule","openApiOperationId":"getRiskRule","summary":"Retrieve a risk rule"},"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":"Risk rule success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/200/content/application~1json/examples/Risk rule response"]}},"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/200/content/application~1json/examples/Risk rule response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/200/content/application~1json/examples/Risk rule response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/200/content/application~1json/examples/Risk rule response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/risk-rules/{ruleId}"},{"label":"Replace a risk rule","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/replaceriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/replaceriskrule","metadata":{"seo":{"title":"Replace a risk rule","description":"BetaOAuth 2.0 scope:okta.governance.riskRule.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"replaceRiskRule","name":"Replace a risk rule","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Replace a risk rule","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.governance.riskRule.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Replaces a risk rule"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ruleId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the risk rule","required":true}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody/content/application~1json/examples/Update risk rule request"]}},"schemaId":"components/schemas/update-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody/content/application~1json/examples/Update risk rule request"],"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody","description":"The updatable attributes of a risk rule"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/governance/api/v1/risk-rules/{ruleId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/update-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody/content/application~1json/examples/Update risk rule request"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/risk-rules/{ruleId}","href":"risk-rules/replaceriskrule","openApiOperationId":"replaceRiskRule","summary":"Replace a risk rule"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/update-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody/content/application~1json/examples/Update risk rule request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/update-risk-rule-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody/content/application~1json/examples/Update risk rule request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk rule success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/200/content/application~1json/examples/Risk rule response"]}},"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/200/content/application~1json/examples/Risk rule response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/200/content/application~1json/examples/Risk rule response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-rule-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/200/content/application~1json/examples/Risk rule response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/risk-rules/{ruleId}"},{"label":"Delete a risk rule","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/deleteriskrule","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/deleteriskrule","metadata":{"seo":{"title":"Delete a risk rule","description":"BetaOAuth 2.0 scope:okta.governance.riskRule.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteRiskRule","name":"Delete a risk rule","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a risk rule","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.governance.riskRule.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a risk rule"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ruleId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the risk rule","required":true}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/risk-rules/{ruleId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"ruleId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v1/risk-rules/{ruleId}","href":"risk-rules/deleteriskrule","openApiOperationId":"deleteRiskRule","summary":"Delete a risk rule"},"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":"Risk rule deleted successfully","headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/risk-rules/{ruleId}"},{"label":"Generate a risk assessment","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/risk-rules/generatepotentialriskassessments","routeSlug":"/iga/openapi/governance-production-reference/risk-rules/generatepotentialriskassessments","metadata":{"seo":{"title":"Generate a risk assessment","description":"BetaOAuth 2.0 scope:okta.governance.riskRule.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generatePotentialRiskAssessments","name":"Generate a risk assessment","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1risk-rule-assessments/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a risk assessment","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.governance.riskRule.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a risk assessment if access is granted"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/potential-risk-assessment-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for bundle request","paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for collection request"]}},"schemaId":"components/schemas/potential-risk-assessment-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for bundle request","paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for collection request"],"pointer":"/paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk assessment request parameters. You must specify either one of the following parameters:"},"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":"resourceOrn"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrnList"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta recommends that you use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrnList"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" parameter."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/risk-rule-assessments","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/potential-risk-assessment-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for bundle request","paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for collection request"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/risk-rule-assessments","href":"risk-rules/generatepotentialriskassessments","openApiOperationId":"generatePotentialRiskAssessments","summary":"Generate a risk assessment"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/potential-risk-assessment-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for bundle request","paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for collection request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/potential-risk-assessment-request","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for bundle request","paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for collection request"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Risk assessment results for the requested resource","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-assessment-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/200/content/application~1json/examples/List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts"]}},"schemaId":"components/schemas/risk-assessment-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/200/content/application~1json/examples/List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/risk-assessment-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/200/content/application~1json/examples/List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/risk-assessment-response","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/200/content/application~1json/examples/List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/risk-rule-assessments"}],"content":{"contentType":"group","meta":{"name":"Risk Rules"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Risk Rules","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":"Risk rules allow you to define criteria for granted principal access that are a risk to your org."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Risk rules are used to support separation of duties (SOD) in Access Certifcations and Access Requests. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://help.okta.com/okta_help.htm?type=oie&id=separation-of-duties"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Separation of duties"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" product documentation."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/risk-rules","summary":"Create a risk rule","prefix":{"name":"post","color":"post"},"badges":[],"link":"/risk-rules/createriskrule","deprecated":false},{"title":"/governance/api/v1/risk-rules","summary":"List all risk rules","prefix":{"name":"get","color":"get"},"badges":[],"link":"/risk-rules/listriskrules","deprecated":false},{"title":"/governance/api/v1/risk-rules/{ruleId}","summary":"Retrieve a risk rule","prefix":{"name":"get","color":"get"},"badges":[],"link":"/risk-rules/getriskrule","deprecated":false},{"title":"/governance/api/v1/risk-rules/{ruleId}","summary":"Replace a risk rule","prefix":{"name":"put","color":"put"},"badges":[],"link":"/risk-rules/replaceriskrule","deprecated":false},{"title":"/governance/api/v1/risk-rules/{ruleId}","summary":"Delete a risk rule","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/risk-rules/deleteriskrule","deprecated":false},{"title":"/governance/api/v1/risk-rule-assessments","summary":"Generate a risk assessment","prefix":{"name":"post","color":"post"},"badges":[],"link":"/risk-rules/generatepotentialriskassessments","deprecated":false}]}]}]}]}},{"type":"group","label":"Resource Owners","link":"/iga/openapi/governance-production-reference/resource-owners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners","items":[{"label":"Configure the resource owners","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/configureresourceowners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/configureresourceowners","metadata":{"seo":{"title":"Configure the resource owners","description":"OAuth 2.0 scope:okta.governance.resourceOwner.manageAdmin roles:SUPER_ADMINPermissions:okta.apps.manageokta.users.readokta.groups.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"configureResourceOwners","name":"Configure the resource owners","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1resource-owners/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Configure the resource owners","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.governance.resourceOwner.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":"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/permissions","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":"Permissions:"},"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.apps.manage"},"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.users.read"},"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.groups.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Configures the owners for resources"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/resource-owners-updatable","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners users request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners group request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Delete all resource owners request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners for an AI agent"]}},"schemaId":"components/schemas/resource-owners-updatable","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners users request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners group request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Delete all resource owners request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners for an AI agent"],"pointer":"/paths/~1governance~1api~1v1~1resource-owners/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/resource-owners","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/resource-owners-updatable","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners users request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners group request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Delete all resource owners request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners for an AI agent"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/resource-owners","href":"resource-owners/configureresourceowners","openApiOperationId":"configureResourceOwners","summary":"Configure the resource owners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/resource-owners-updatable","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners users request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners group request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Delete all resource owners request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners for an AI agent"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/resource-owners-updatable","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners users request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners group request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Delete all resource owners request","paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners for an AI agent"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource owners success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resource-owners-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners users response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners group response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Delete all resource owners response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners for an AI agent response"]}},"schemaId":"components/schemas/resource-owners-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners users response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners group response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Delete all resource owners response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners for an AI agent response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1resource-owners/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/resource-owners-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners users response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners group response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Delete all resource owners response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners for an AI agent response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resource-owners-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners users response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners group response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Delete all resource owners response","paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners for an AI agent response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/resource-owners"},{"label":"List all resources with owners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/listresourceowners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/listresourceowners","metadata":{"seo":{"title":"List all resources with owners","description":"OAuth 2.0 scope:okta.governance.resourceOwner.readAdmin roles:SUPER_ADMINPermissions:okta.apps.readokta.users.readokta.groups.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listResourceOwners","name":"List all resources with owners","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1resource-owners/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all resources with owners","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.governance.resourceOwner.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":"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/permissions","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":"Permissions:"},"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.apps.read"},"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.users.read"},"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.groups.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all resources with assigned owners for an app (the parent resource) or for standalone AI agents."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this request, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter with either a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for apps, groups, entitlements, and bundles),"},"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":"resource.orn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter expression (for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resource type),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.type eq \"ai-agents\""},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (for AI agents, optionally combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to scope to a specific AI agent or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal.orn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to filter by owner)."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method returns all the resources, such as entitlements, entitlement bundles, or AI agents, that have owners assigned."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"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":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.profile.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.profile.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filtering)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal.orn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (must be combined with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.type eq \"ai-agents\""},"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":" 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":[]}]}]}]},{"$$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":" The principal referenced by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal.orn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must already exist as a registered resource owner in the system. If the principal has never been assigned as an owner, the API returns a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"400"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" error rather than an empty result set."},"children":[]}]}]}]}],"required":true,"examples":{"FilterByParentResourceOrn":{"summary":"Filter by parentResourceOrn","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\""},"FilterByResourceOrn":{"summary":"Filter by resource orn, which can be an app or a bundle","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.orn eq \"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6\""},"FilterByResourceOrnCollections":{"summary":"Filter by resource orn, which is a collection","value":"resource.orn eq \"orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:colvmzzTr4xO45Ujn0g4\""},"FilterByResourceType":{"summary":"Filter by resource type, which can be an app or a bundle","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\""},"FilterByResourceNameStartsWith":{"summary":"Filter by the resource name for a specified resource type, starting with the provided prefix","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\" AND resource.profile.name sw \"License\""},"FilterByResourceNameContains":{"summary":"Filter by the resource name for a specified resource type that contains the provided substring","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\" AND resource.profile.name co \"License\""},"FilterByResourceTypeAIAgents":{"summary":"Filter by resource type ai-agents (standalone, without parentResourceOrn)","value":"resource.type eq \"ai-agents\""},"FilterByPrincipalOrnAndResourceType":{"summary":"Filter by principal orn combined with resource type","value":"resource.type eq \"ai-agents\" AND principal.orn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u1tgwssMI9jYizU0g5\""},"FilterByPrincipalOrnAndParentResourceOrnAIAgent":{"summary":"Filter by principal orn combined with an AI agent parent resource orn","value":"resource.type eq \"ai-agents\" AND parentResourceOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wp1234567890\" AND principal.orn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g1tgwssMI9jYizU0g5\""}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"include","in":"query","schemaId":"schema_1410","description":"Adds additional properties in the response","examples":{"IncludeParentResourceOwners":{"summary":"Include parent resource owners in the response","value":"parent_resource_owner"}}}],"pointer":"/paths/~1governance~1api~1v1~1resource-owners/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/resource-owners","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"include","in":"query","required":false,"example":"parent_resource_owner","schemaId":"schema_1410"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/resource-owners","href":"resource-owners/listresourceowners","openApiOperationId":"listResourceOwners","summary":"List all resources with owners"},"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":"Resource owners list success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resource-owners-list-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success with parent resource owner included response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response for AI agents"]}},"schemaId":"components/schemas/resource-owners-list-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success with parent resource owner included response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response for AI agents"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1resource-owners/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/resource-owners-list-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success with parent resource owner included response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response for AI agents"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resource-owners-list-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success with parent resource owner included response","paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response for AI agents"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/resource-owners"},{"label":"Update a resource owner","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/updateresourceowners","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/updateresourceowners","metadata":{"seo":{"title":"Update a resource owner","description":"OAuth 2.0 scope:okta.governance.resourceOwner.manageAdmin roles:SUPER_ADMINPermissions:okta.apps.manageokta.users.readokta.groups.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateResourceOwners","name":"Update a resource owner","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1resource-owners/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a resource owner","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.governance.resourceOwner.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":"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/permissions","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":"Permissions:"},"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.apps.manage"},"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.users.read"},"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.groups.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a resource owner."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/resource-owners-patch","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/requestBody/content/application~1json/examples/Create or update resource owners request"]}},"schemaId":"components/schemas/resource-owners-patch","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/requestBody/content/application~1json/examples/Create or update resource owners request"],"pointer":"/paths/~1governance~1api~1v1~1resource-owners/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/resource-owners","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/resource-owners-patch","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/requestBody/content/application~1json/examples/Create or update resource owners request"]}},"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v1/resource-owners","href":"resource-owners/updateresourceowners","openApiOperationId":"updateResourceOwners","summary":"Update a resource owner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/resource-owners-patch","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/requestBody/content/application~1json/examples/Create or update resource owners request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/resource-owners-patch","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/requestBody/content/application~1json/examples/Create or update resource owners request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Resource owners success patch response","headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1resource-owners/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/resource-owners"},{"label":"List all unowned resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/resource-owners/listresourceownercatalogresources","routeSlug":"/iga/openapi/governance-production-reference/resource-owners/listresourceownercatalogresources","metadata":{"seo":{"title":"List all unowned resources","description":"OAuth 2.0 scope:okta.governance.resourceOwner.readAdmin roles:SUPER_ADMINPermissions:okta.apps.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listResourceOwnerCatalogResources","name":"List all unowned resources","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all unowned resources","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.governance.resourceOwner.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":"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/permissions","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":"Permissions:"},"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.apps.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all unowned resources for an app (the parent resource)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For this request, you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter with a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter expression."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This method returns all the resources for an app, such as entitlements or entitlement bundles, that don't have owners assigned."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (required)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.profile.*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (both "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentResourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filters are required for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resource.profile.*"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filtering)"},"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":[]}]}]}]}],"required":true,"examples":{"FilterByParentResourceOrnAndResourceType":{"summary":"Filter by resource type","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\""},"FilterByResourceNameStartsWith":{"summary":"Filter by the resource name for a specified resource type, starting with the provided prefix","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\" AND resource.profile.name sw \"License\""},"FilterByResourceNameContains":{"summary":"Filter by the resource name for a specified resource type that contains the provided substring","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\" AND resource.profile.name co \"License\""},"FilterByParentResourceOrnAndResourceTypeForEntitlementValues":{"summary":"Filter by resource type and parent ID","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-values AND resource.profile.parent.id eq \"esp2lr1lavoGDYw5U8g6\""},"FilterByResourceNameStartsWithForEntitlementValues":{"summary":"Filter by the resource name for a specified resource type, starting with the provided prefix and parent ID","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-values\" AND resource.profile.parent.id eq \"esp2lr1lavoGDYw5U8g6\" AND resource.profile.name sw \"License\""},"FilterByResourceNameContainsForEntitlementValues":{"summary":"Filter by the resource name for a specified resource type that contains the provided substring and parent ID","value":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-values\" AND resource.profile.parent.id eq \"esp2lr1lavoGDYw5U8g6\" AND resource.profile.name co \"License\""}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/resource-owners/catalog/resources","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/resource-owners/catalog/resources","href":"resource-owners/listresourceownercatalogresources","openApiOperationId":"listResourceOwnerCatalogResources","summary":"List all unowned resources"},"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":"Resource owners catalog resources success response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resource-owners-catalog-resources-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement bundle catalog success response","paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement values catalog success response"]}},"schemaId":"components/schemas/resource-owners-catalog-resources-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement bundle catalog success response","paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement values catalog success response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/resource-owners-catalog-resources-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement bundle catalog success response","paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement values catalog success response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/resource-owners-catalog-resources-response","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement bundle catalog success response","paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement values catalog success response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/resource-owners/catalog/resources"}],"content":{"contentType":"group","meta":{"name":"Resource Owners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resource Owners","showPageActions":true},{"nodeType":"markdoc","content":"The Resource Owners API allows you to manage assigning owners to resources in your Okta Identity Governance (OIG) org. You can drive automation and simplify OIG configuration by assigning owners to resources, such as apps, groups, entitlements, and collections. For example, resource owners are automatically assign as reviewers for access certifications or requests that are scoped with specific owner-assigned resources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/resource-owners","summary":"Configure the resource owners","prefix":{"name":"post","color":"post"},"badges":[],"link":"/resource-owners/configureresourceowners","deprecated":false},{"title":"/governance/api/v1/resource-owners","summary":"List all resources with owners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resource-owners/listresourceowners","deprecated":false},{"title":"/governance/api/v1/resource-owners","summary":"Update a resource owner","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/resource-owners/updateresourceowners","deprecated":false},{"title":"/governance/api/v1/resource-owners/catalog/resources","summary":"List all unowned resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/resource-owners/listresourceownercatalogresources","deprecated":false}]}]}]}]}},{"type":"group","label":"Labels","link":"/iga/openapi/governance-production-reference/labels","routeSlug":"/iga/openapi/governance-production-reference/labels","items":[{"label":"Create a label","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/createlabel","routeSlug":"/iga/openapi/governance-production-reference/labels/createlabel","metadata":{"seo":{"title":"Create a label","description":"OAuth 2.0 scope:okta.governance.labels.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createLabel","name":"Create a label","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1labels/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a label","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.governance.labels.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 label that includes the key name of the label and its values"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/label-create","exampleIds":["paths/~1governance~1api~1v1~1labels/post/requestBody/content/application~1json/examples/Create a resource label request"]}},"schemaId":"components/schemas/label-create","exampleIds":["paths/~1governance~1api~1v1~1labels/post/requestBody/content/application~1json/examples/Create a resource label request"],"pointer":"/paths/~1governance~1api~1v1~1labels/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/labels","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/label-create","exampleIds":["paths/~1governance~1api~1v1~1labels/post/requestBody/content/application~1json/examples/Create a resource label request"]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/labels","href":"labels/createlabel","openApiOperationId":"createLabel","summary":"Create a label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/label-create","exampleIds":["paths/~1governance~1api~1v1~1labels/post/requestBody/content/application~1json/examples/Create a resource label request"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/label-create","exampleIds":["paths/~1governance~1api~1v1~1labels/post/requestBody/content/application~1json/examples/Create a resource label request"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"Resource label created successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/201/content/application~1json/examples/Label response"]}},"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/201/content/application~1json/examples/Label response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1labels/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/201/content/application~1json/examples/Label response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/201/content/application~1json/examples/Label response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/labels"},{"label":"List all labels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/listlabels","routeSlug":"/iga/openapi/governance-production-reference/labels/listlabels","metadata":{"seo":{"title":"List all labels","description":"OAuth 2.0 scope:okta.governance.labels.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLabels","name":"List all labels","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all labels","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.governance.labels.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 labels"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"values.name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"sw"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"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":[]}]}]}]}],"examples":{"FilterByNameStartsWith":{"summary":"Filter by label value name, starting with the provided prefix","value":"values.name sw \"SOD\""},"FilterByNameContains":{"summary":"Filter by label value name that contains the provided substring","value":"values.name co \"SOD\""}}}],"pointer":"/paths/~1governance~1api~1v1~1labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/labels","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"values.name sw \"SOD\"","schemaId":"components/schemas/scim-filter"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","429","500"],"pointer":"/governance/api/v1/labels","href":"labels/listlabels","openApiOperationId":"listLabels","summary":"List all labels"},"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 labels","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-labels","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/200/content/application~1json/examples/List labels response"]}},"schemaId":"components/schemas/list-labels","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/200/content/application~1json/examples/List labels response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-labels","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/200/content/application~1json/examples/List labels response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-labels","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/200/content/application~1json/examples/List labels response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/labels"},{"label":"Delete a label","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/deletelabel","routeSlug":"/iga/openapi/governance-production-reference/labels/deletelabel","metadata":{"seo":{"title":"Delete a label","description":"OAuth 2.0 scope:okta.governance.labels.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteLabel","name":"Delete a label","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a label","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.governance.labels.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 label key and its associated label values"},"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 delete a label key if there are no associated label values assigned to any resources."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"labelId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the label","required":true}],"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/labels/{labelId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"labelId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","401","403","429","500"],"pointer":"/governance/api/v1/labels/{labelId}","href":"labels/deletelabel","openApiOperationId":"deleteLabel","summary":"Delete a label"},"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":"Label deleted successfully","headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/labels/{labelId}"},{"label":"Retrieve a label","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/getlabel","routeSlug":"/iga/openapi/governance-production-reference/labels/getlabel","metadata":{"seo":{"title":"Retrieve a label","description":"OAuth 2.0 scope:okta.governance.labels.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getLabel","name":"Retrieve a label","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a label","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.governance.labels.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 single label"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"labelId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the label","required":true}],"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/labels/{labelId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"labelId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/labels/{labelId}","href":"labels/getlabel","openApiOperationId":"getLabel","summary":"Retrieve a label"},"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":"Resource label retrieved successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/200/content/application~1json/examples/Label response"]}},"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/200/content/application~1json/examples/Label response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/200/content/application~1json/examples/Label response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/200/content/application~1json/examples/Label response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/labels/{labelId}"},{"label":"Update a label","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/updatelabel","routeSlug":"/iga/openapi/governance-production-reference/labels/updatelabel","metadata":{"seo":{"title":"Update a label","description":"OAuth 2.0 scope:okta.governance.labels.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateLabel","name":"Update a label","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a label","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.governance.labels.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 the properties of a label"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"labelId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the label","required":true}],"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patch-labels","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update label category |tooltip| Request body for updating label category","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - add new label value |tooltip| Request body for adding label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - remove label value |tooltip| Request body for removing label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - update label value |tooltip| Request body for updating label value"]}},"schemaId":"components/schemas/patch-labels","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update label category |tooltip| Request body for updating label category","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - add new label value |tooltip| Request body for adding label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - remove label value |tooltip| Request body for removing label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - update label value |tooltip| Request body for updating label value"],"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/labels/{labelId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"labelId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/patch-labels","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update label category |tooltip| Request body for updating label category","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - add new label value |tooltip| Request body for adding label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - remove label value |tooltip| Request body for removing label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - update label value |tooltip| Request body for updating label value"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/labels/{labelId}","href":"labels/updatelabel","openApiOperationId":"updateLabel","summary":"Update a label"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/patch-labels","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update label category |tooltip| Request body for updating label category","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - add new label value |tooltip| Request body for adding label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - remove label value |tooltip| Request body for removing label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - update label value |tooltip| Request body for updating label value"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/patch-labels","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update label category |tooltip| Request body for updating label category","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - add new label value |tooltip| Request body for adding label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - remove label value |tooltip| Request body for removing label value","paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - update label value |tooltip| Request body for updating label value"]}},"examples":[{},{},{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Resource label updated successfully","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/200/content/application~1json/examples/Label response"]}},"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/200/content/application~1json/examples/Label response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/200/content/application~1json/examples/Label response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/label","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/200/content/application~1json/examples/Label response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/labels/{labelId}"},{"label":"List all labeled resources","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/listlabelresources","routeSlug":"/iga/openapi/governance-production-reference/labels/listlabelresources","metadata":{"seo":{"title":"List all labeled resources","description":"OAuth 2.0 scope:okta.governance.labels.readAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listLabelResources","name":"List all labeled resources","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1resource-labels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all labeled resources","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.governance.labels.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 labeled resources"},"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 create a custom admin role to view labeled resources, ensure that the custom role has permissions to view the resource and governance labels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, to view labeled apps, the custom admin role must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.apps.read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.governance.labels.read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1386","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that returns entries based on the following properties and supported 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":"orn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":  supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labelValueId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": supports "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value is taken from the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{objectType}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute in the resource "},"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":". For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlement-values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for entitlement value resources.)"},"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":[]}]}]}]}],"required":true,"examples":{"FilterByOrn":{"summary":"Filter by resource ORN representing a single resource","value":"orn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""},"FilterByLabelIdAndAppsResourceType":{"summary":"Filter by label value ID and app resource type","value":"labelValueId eq \"lblo3v6xlwdtEX2il1d6\" AND resourceType eq \"apps\""},"FilterByLabelIdAndGroupsResourceType":{"summary":"Filter by label value ID and groups resource type","value":"labelValueId eq \"lblo3v6xlwdtEX2il1d6\" AND resourceType eq \"groups\""},"FilterByLabelIdAndEntitlementType":{"summary":"Filter by label value id and entitlement-value resource type","value":"labelValueId eq \"ento3v6xlwdtEX2il1d6\" AND resourceType eq \"entitlement-values\""},"FilterByLabelIdAndCollectionType":{"summary":"Filter by label value id and entitlement-value resource type","value":"labelValueId eq \"ento3v6xlwdtEX2il1d6\" AND resourceType eq \"collections\""},"FilterByMultipleLabelIdsAndAppsResourceType":{"summary":"Filter by multiple label value IDs and app resource type","value":"(labelValueId eq \"lblo3v6xlwdtEX2il1d6\" OR labelValueId eq \"lblo3v6xlwdtEX2il1d7\") AND resourceType eq \"apps\""},"FilterByMultipleLabelIdsAndResourceTypes":{"summary":"Filter by several label value ID and app resource type","value":"(labelValueId eq \"lblo3v6xlwdtEX2il1d6\" AND resourceType eq \"apps\") OR (labelValueId eq \"lblo3v6xlwdtEX2il1d7\" AND resourceType eq \"groups\")"}}},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v1~1resource-labels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/resource-labels","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":true,"example":"orn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\"","schemaId":"components/schemas/scim-filter"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","429","500"],"pointer":"/governance/api/v1/resource-labels","href":"labels/listlabelresources","openApiOperationId":"listLabelResources","summary":"List all labeled resources"},"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 resources with labels","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/200/content/application~1json/examples/List resources with labels response"]}},"schemaId":"components/schemas/list-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/200/content/application~1json/examples/List resources with labels response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1resource-labels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/list-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/200/content/application~1json/examples/List resources with labels response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/list-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/200/content/application~1json/examples/List resources with labels response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/resource-labels"},{"label":"Assign the labels to resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/assignresourcelabels","routeSlug":"/iga/openapi/governance-production-reference/labels/assignresourcelabels","metadata":{"seo":{"title":"Assign the labels to resources","description":"OAuth 2.0 scope:okta.governance.labels.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"assignResourceLabels","name":"Assign the labels to resources","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1resource-labels~1assign/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assign the labels to resources","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.governance.labels.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":"Assigns the specified label values to resources"},"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 create a custom admin role for assigning label values to resources, ensure that the custom role has permissions to edit the resource and governance labels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, to assign labels to apps, the custom admin role must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.apps.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.governance.labels.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody/content/application~1json/examples/Assign resource labels example"]}},"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody/content/application~1json/examples/Assign resource labels example"],"pointer":"/paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/resource-labels/assign","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody/content/application~1json/examples/Assign resource labels example"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/resource-labels/assign","href":"labels/assignresourcelabels","openApiOperationId":"assignResourceLabels","summary":"Assign the labels to resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody/content/application~1json/examples/Assign resource labels example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody/content/application~1json/examples/Assign resource labels example"]}},"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 resources with labels","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/assignment-resource-labels-result","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/200/content/application~1json/examples/List resources with labels response"]}},"schemaId":"components/schemas/assignment-resource-labels-result","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/200/content/application~1json/examples/List resources with labels response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/assignment-resource-labels-result","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/200/content/application~1json/examples/List resources with labels response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/assignment-resource-labels-result","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/200/content/application~1json/examples/List resources with labels response"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/resource-labels/assign"},{"label":"Remove the labels from resources","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/labels/removeresourcelabels","routeSlug":"/iga/openapi/governance-production-reference/labels/removeresourcelabels","metadata":{"seo":{"title":"Remove the labels from resources","description":"OAuth 2.0 scope:okta.governance.labels.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"removeResourceLabels","name":"Remove the labels from resources","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1resource-labels~1unassign/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove the labels from resources","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.governance.labels.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 the specified label values from resources"},"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 create a custom admin role for assigning and unassigning labels to resources, ensure that the custom role has permissions to edit the resource and governance labels."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, to unassign labels from apps, the custom admin role must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.apps.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.governance.labels.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permissions."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody/content/application~1json/examples/Unassign resources labels example"]}},"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody/content/application~1json/examples/Unassign resources labels example"],"pointer":"/paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/resource-labels/unassign","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody/content/application~1json/examples/Unassign resources labels example"]}},"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v1/resource-labels/unassign","href":"labels/removeresourcelabels","openApiOperationId":"removeResourceLabels","summary":"Remove the labels from resources"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody/content/application~1json/examples/Unassign resources labels example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/assign-resource-labels","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody/content/application~1json/examples/Unassign resources labels example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Label deleted successfully","headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/resource-labels/unassign"}],"content":{"contentType":"group","meta":{"name":"Labels"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Labels","showPageActions":true},{"nodeType":"markdoc","content":"The Labels API enables you to categorize and organize resources such as apps, groups, entitlements, and collections. You can create, update, and assign key-value labels to resources to support automation, streamline configuration, and simplify the management of access reviews and requests."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/labels","summary":"Create a label","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels/createlabel","deprecated":false},{"title":"/governance/api/v1/labels","summary":"List all labels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/labels/listlabels","deprecated":false},{"title":"/governance/api/v1/labels/{labelId}","summary":"Delete a label","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/labels/deletelabel","deprecated":false},{"title":"/governance/api/v1/labels/{labelId}","summary":"Retrieve a label","prefix":{"name":"get","color":"get"},"badges":[],"link":"/labels/getlabel","deprecated":false},{"title":"/governance/api/v1/labels/{labelId}","summary":"Update a label","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/labels/updatelabel","deprecated":false},{"title":"/governance/api/v1/resource-labels","summary":"List all labeled resources","prefix":{"name":"get","color":"get"},"badges":[],"link":"/labels/listlabelresources","deprecated":false},{"title":"/governance/api/v1/resource-labels/assign","summary":"Assign the labels to resources","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels/assignresourcelabels","deprecated":false},{"title":"/governance/api/v1/resource-labels/unassign","summary":"Remove the labels from resources","prefix":{"name":"post","color":"post"},"badges":[],"link":"/labels/removeresourcelabels","deprecated":false}]}]}]}]}},{"type":"group","label":"Principal Settings","link":"/iga/openapi/governance-production-reference/principal-settings","routeSlug":"/iga/openapi/governance-production-reference/principal-settings","items":[{"label":"Update the principal settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/principal-settings/updateprincipalsettings","routeSlug":"/iga/openapi/governance-production-reference/principal-settings/updateprincipalsettings","metadata":{"seo":{"title":"Update the principal settings","description":"BetaOAuth 2.0 scope:okta.governance.principalSettings.manageAdmin roles:SUPER_ADMINACCESS_CERTIFICATION_ADMINACCESS_REQUESTS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updatePrincipalSettings","name":"Update the principal settings","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the principal 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":"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.governance.principalSettings.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":"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":"ACCESS_CERTIFICATION_ADMIN"},"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":"ACCESS_REQUESTS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the settings for a principal"},"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":" To update the principal settings, you must be assigned to either the SUPER_ADMIN role or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both the ACCESS_CERTIFICATION_ADMIN and the ACCESS_REQUESTS_ADMIN roles."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"targetPrincipalId","in":"path","schemaId":"schema_1378","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 target principal in Okta ID format or "},"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":" format"},"children":[]}]}]}],"required":true}],"pointer":"/paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/principal-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/Admin-appointed delegate","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/No delegate appointment"]}},"schemaId":"components/schemas/principal-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/Admin-appointed delegate","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/No delegate appointment"],"pointer":"/paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/principal-settings/{targetPrincipalId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"targetPrincipalId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/principal-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/Admin-appointed delegate","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/No delegate appointment"]}},"responseCodes":["200","400","401","403","404","429","500"],"pointer":"/governance/api/v1/principal-settings/{targetPrincipalId}","href":"principal-settings/updateprincipalsettings","openApiOperationId":"updatePrincipalSettings","summary":"Update the principal settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/principal-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/Admin-appointed delegate","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/No delegate appointment"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/principal-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/Admin-appointed delegate","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/No delegate appointment"]}},"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 governance principal settings patch response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-settings","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/A delegate appointment","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/No delegate appointment"]}},"schemaId":"components/schemas/principal-settings","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/A delegate appointment","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/No delegate appointment"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"When governance settings fails as bad request","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Missing required fields","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Invalid properties in the settings request"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Missing required fields","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Invalid properties in the settings request"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested principal wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/principal-settings","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/A delegate appointment","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/No delegate appointment"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/principal-settings","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/A delegate appointment","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/No delegate appointment"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Missing required fields","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Invalid properties in the settings request"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Missing required fields","paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Invalid properties in the settings request"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/principal-settings/{targetPrincipalId}"}],"content":{"contentType":"group","meta":{"name":"Principal Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Principal Settings","showPageActions":true},{"nodeType":"markdoc","content":"The Principal Settings API allows admins to manage governance settings for a principal. Use this API to manage settings for a target principal, such as appointing a delegate for governance reviews."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/principal-settings/{targetPrincipalId}","summary":"Update the principal settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/principal-settings/updateprincipalsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Delegates","link":"/iga/openapi/governance-production-reference/delegates","routeSlug":"/iga/openapi/governance-production-reference/delegates","items":[{"label":"List all delegate appointments","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/delegates/listdelegateappointments","routeSlug":"/iga/openapi/governance-production-reference/delegates/listdelegateappointments","metadata":{"seo":{"title":"List all delegate appointments","description":"BetaOAuth 2.0 scope:okta.governance.delegates.readAdmin roles:SUPER_ADMINACCESS_CERTIFICATION_ADMINACCESS_REQUESTS_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listDelegateAppointments","name":"List all delegate appointments","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1delegates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all delegate appointments","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.governance.delegates.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":"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":"ACCESS_CERTIFICATION_ADMIN"},"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":"ACCESS_REQUESTS_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all delegate appointments in your org."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can filter delegate appointments for a specific user with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"filter"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can also manage the number of records in the response with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"limit"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"after"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameters."},"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":" To list all delegate appointments, you must be assigned to either the SUPER_ADMIN role or"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"both the ACCESS_CERTIFICATION_ADMIN and the ACCESS_REQUESTS_ADMIN roles."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The following are request examples with query parameters:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists at most 20 delegate appointments"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"/governance/api/v1/delegates?limit=20\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"/governance/api/v1/delegates?limit=20\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the next 10 results of delegate appointments after a specific cursor"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"/governance/api/v1/delegates?limit=10&after=gda123ABCXYZ456DEF\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"/governance/api/v1/delegates?limit=10&after=gda123ABCXYZ456DEF\n"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists at most 2 delegate appointments with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delegatorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" equals "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"00ub0oNGTSWTBKOLAAAA"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"00u2lxfQaw8WRlkQt0g4"},"children":[]}]},{"$$mdtype":"Node","type":"fence","attributes":{"content":"/governance/api/v1/delegates?filter=(delegatorId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20OR%20delegatorId%20eq%20%2200ub0oNGTSWTBKOLGLNS%22)&limit=2\n"},"children":[{"$$mdtype":"Node","type":"text","attributes":{"content":"/governance/api/v1/delegates?filter=(delegatorId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20OR%20delegatorId%20eq%20%2200ub0oNGTSWTBKOLGLNS%22)&limit=2\n"},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1411","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter expression for retrieving delegates based on specific criteria."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"delegatorId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is supported with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operator."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]}],"pointer":"/paths/~1governance~1api~1v1~1delegates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/delegates","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"delegatorId eq \"00ub0oNGTSWTBKOLGLNR\" OR delegatorId eq \"00ub0oNGTSWTBKOLGLNS\"","schemaId":"schema_1411"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/delegates","href":"delegates/listdelegateappointments","openApiOperationId":"listDelegateAppointments","summary":"List all delegate appointments"},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/delegate-appointment-list","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/Delegate appointments","paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/User has no delegates"]}},"schemaId":"components/schemas/delegate-appointment-list","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/Delegate appointments","paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/User has no delegates"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"400","description":"An invalid list request error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1delegates/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/delegate-appointment-list","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/Delegate appointments","paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/User has no delegates"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/delegate-appointment-list","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/Delegate appointments","paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/User has no delegates"]}}},{"code":"400","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidFilter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidAfter","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1delegates/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/delegates"}],"content":{"contentType":"group","meta":{"name":"Delegates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delegates","showPageActions":true},{"nodeType":"markdoc","content":"The Delegates API allows admins to view governance delegates for a principal (for example, an Okta user). Admins can appoint delegates to perform governance tasks and end users can appoint delegates for their own governance tasks."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/delegates","summary":"List all delegate appointments","prefix":{"name":"get","color":"get"},"badges":[],"link":"/delegates/listdelegateappointments","deprecated":false}]}]}]}]}},{"type":"group","label":"Security Access Reviews","link":"/iga/openapi/governance-production-reference/security-access-reviews","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews","items":[{"label":"List all security access reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviews","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviews","metadata":{"seo":{"title":"List all security access reviews","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSecurityAccessReviews","name":"List all security access reviews","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all security access reviews","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all security access reviews"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1378","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters security access reviews."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"eq"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"co"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#operators"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"operators"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are supported for string properties."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lt"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operators are supported for date properties."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"FilterByName":{"summary":"Filter by name provided for the security access review","value":"name co \"Git\""},"FilterByStatus":{"summary":"Filter by status of the security access review","value":"status eq \"ACTIVE\""},"FilterByReviewerName":{"summary":"Filter by reviewer.name. Note that it compares against the first name and last name of the reviewer.","value":"reviewer.name co \"John\""},"FilterByCreated":{"summary":"Filter by created","value":"created gt \"2022-05-24T14:15:22Z\""}}},{"name":"orderBy","in":"query","schemaId":"schema_1381","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to sort the results, in ascending ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or descending ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") order."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sorting is applied to only one field."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"OrderByName":{"summary":"Order by name","value":"name desc"},"OrderByCreated":{"summary":"Order by created","value":"created desc"},"OrderByEndTime":{"summary":"Order by endTime","value":"endTime desc"},"OrderByStatus":{"summary":"Order by status","value":"status desc"},"OrderById":{"summary":"Order by id","value":"id desc"}}},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[{"name":"filter","in":"query","required":false,"example":"name co \"Git\"","schemaId":"schema_1378"},{"name":"orderBy","in":"query","required":false,"example":"name desc","schemaId":"schema_1381","style":"form","explode":false},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews","href":"security-access-reviews/listsecurityaccessreviews","openApiOperationId":"listSecurityAccessReviews","summary":"List all security access reviews"},"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 security access reviews get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-reviews","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/200/content/application~1json/examples/Lists all security access reviews based on filter criteria"]}},"schemaId":"components/schemas/security-access-reviews","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/200/content/application~1json/examples/Lists all security access reviews based on filter criteria"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-reviews","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/200/content/application~1json/examples/Lists all security access reviews based on filter criteria"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-reviews","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/200/content/application~1json/examples/Lists all security access reviews based on filter criteria"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews"},{"label":"Create a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/createsecurityaccessreview","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/createsecurityaccessreview","metadata":{"seo":{"title":"Create a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createSecurityAccessReview","name":"Create a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a security access review for a target principal (such as a user)"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody/content/application~1json/examples/Payload to create a security access review"]}},"schemaId":"components/schemas/security-access-review-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody/content/application~1json/examples/Payload to create a security access review"],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/security-access-reviews","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/security-access-review-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody/content/application~1json/examples/Payload to create a security access review"]}},"responseCodes":["202","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews","href":"security-access-reviews/createsecurityaccessreview","openApiOperationId":"createSecurityAccessReview","summary":"Create a security access review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/security-access-review-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody/content/application~1json/examples/Payload to create a security access review"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody/content/application~1json/examples/Payload to create a security access review"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A successful security access reviews post response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/202/content/application~1json/examples/Create a security access review response"]}},"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/202/content/application~1json/examples/Create a security access review response"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/202/content/application~1json/examples/Create a security access review response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/202/content/application~1json/examples/Create a security access review response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews"},{"label":"Retrieve the statistics for security access reviews","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewsstats","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewsstats","metadata":{"seo":{"title":"Retrieve the statistics for security access reviews","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSecurityAccessReviewsStats","name":"Retrieve the statistics for security access reviews","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1stats/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the statistics for security access reviews","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the statistics for security access reviews in an org"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/stats","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/stats","href":"security-access-reviews/getsecurityaccessreviewsstats","openApiOperationId":"getSecurityAccessReviewsStats","summary":"Retrieve the statistics for security access reviews"},"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 security access reviews stats get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-reviews-stats","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/200/content/application~1json/examples/Statistics for all security access reviews"]}},"schemaId":"components/schemas/security-access-reviews-stats","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/200/content/application~1json/examples/Statistics for all security access reviews"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-reviews-stats","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/200/content/application~1json/examples/Statistics for all security access reviews"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-reviews-stats","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/200/content/application~1json/examples/Statistics for all security access reviews"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/stats"},{"label":"Retrieve a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreview","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreview","metadata":{"seo":{"title":"Retrieve a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSecurityAccessReview","name":"Retrieve a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves a security access review"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}","href":"security-access-reviews/getsecurityaccessreview","openApiOperationId":"getSecurityAccessReview","summary":"Retrieve a security access review"},"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 security access review get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/200/content/application~1json/examples/Create a security access review response"]}},"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/200/content/application~1json/examples/Create a security access review response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/200/content/application~1json/examples/Create a security access review response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/200/content/application~1json/examples/Create a security access review response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}"},{"label":"Update a security access review","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/updatesecurityaccessreview","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/updatesecurityaccessreview","metadata":{"seo":{"title":"Update a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateSecurityAccessReview","name":"Update a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates a security access review"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-update-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody/content/application~1json/examples/Payload to update a security access review"]}},"schemaId":"components/schemas/security-access-review-update-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody/content/application~1json/examples/Payload to update a security access review"],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/security-access-review-update-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody/content/application~1json/examples/Payload to update a security access review"]}},"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}","href":"security-access-reviews/updatesecurityaccessreview","openApiOperationId":"updateSecurityAccessReview","summary":"Update a security access review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/security-access-review-update-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody/content/application~1json/examples/Payload to update a security access review"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-update-request","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody/content/application~1json/examples/Payload to update a security access review"]}},"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 security access reviews patch response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/200/content/application~1json/examples/Create a security access review response"]}},"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/200/content/application~1json/examples/Create a security access review response"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/200/content/application~1json/examples/Create a security access review response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/200/content/application~1json/examples/Create a security access review response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}"},{"label":"Generate a summary for a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewsummary","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewsummary","metadata":{"seo":{"title":"Generate a summary for a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateSecurityAccessReviewSummary","name":"Generate a summary for a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a summary for a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a summary for a security access review"},"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":"Notes:"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/iga/openapi/governance.api/tag/Org-Governance-Settings/#tag/Org-Governance-Settings/operation/updateOrgSettings!path=governanceAI&t=request"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"governanceAI.securityAccessReview.enabled"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" org governance setting must be enabled for users to generate summaries for security access reviews."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is excluded from the Okta for AI Agents - Core SKU, which is the version of Okta for AI Agents available to FedRAMP Moderate and FedRAMP High customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta for AI Agents - Core isn't available in Okta for US Military cells. For a current list of features that are excluded from the Okta for AI Agents - Core SKU, please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.okta.com/help/s/article/okta-us-public-sector-limitations-or-exceptions?language=en_US"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta US Public Sector Limitations or Exceptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documentation."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/summary","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/summary","href":"security-access-reviews/generatesecurityaccessreviewsummary","openApiOperationId":"generateSecurityAccessReviewSummary","summary":"Generate a summary for a security access review"},"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 security access review summary response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"]}},"schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/summary"},{"label":"List the actions for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewactions","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewactions","metadata":{"seo":{"title":"List the actions for a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSecurityAccessReviewActions","name":"List the actions for a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the actions for a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the available actions for a specific security access review"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions","href":"security-access-reviews/listsecurityaccessreviewactions","openApiOperationId":"listSecurityAccessReviewActions","summary":"List the actions for a security access review"},"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 security access review actions get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-actions","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/200/content/application~1json/examples/All possible actions for a security access review response"]}},"schemaId":"components/schemas/security-access-review-actions","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/200/content/application~1json/examples/All possible actions for a security access review response"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review-actions","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/200/content/application~1json/examples/All possible actions for a security access review response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-actions","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/200/content/application~1json/examples/All possible actions for a security access review response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions"},{"label":"Execute an action on a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaction","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaction","metadata":{"seo":{"title":"Execute an action on a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeSecurityAccessReviewAction","name":"Execute an action on a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute an action on a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Executes a specified action on a security access review"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-action"}},"schemaId":"components/schemas/security-access-review-action","pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/security-access-review-action"}},"responseCodes":["202","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions","href":"security-access-reviews/executesecurityaccessreviewaction","openApiOperationId":"executeSecurityAccessReviewAction","summary":"Execute an action on a security access review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/security-access-review-action","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-action"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Action initiated successfully"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions"},{"label":"Retrieve the principal for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewprincipaldetails","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/getsecurityaccessreviewprincipaldetails","metadata":{"seo":{"title":"Retrieve the principal for a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getSecurityAccessReviewPrincipalDetails","name":"Retrieve the principal for a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the principal for a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the details of a security access review's principal target"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/principal","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/principal","href":"security-access-reviews/getsecurityaccessreviewprincipaldetails","openApiOperationId":"getSecurityAccessReviewPrincipalDetails","summary":"Retrieve the principal for a security access review"},"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 security access review principal details get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-principal","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/200/content/application~1json/examples/Target principal of a security access review response"]}},"schemaId":"components/schemas/security-access-review-principal","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/200/content/application~1json/examples/Target principal of a security access review response"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review-principal","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/200/content/application~1json/examples/Target principal of a security access review response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-principal","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/200/content/application~1json/examples/Target principal of a security access review response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/principal"},{"label":"List the access items for a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccesses","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccesses","metadata":{"seo":{"title":"List the access items for a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSecurityAccessReviewAccesses","name":"List the access items for a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the access items for a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the access items for a specific security access review."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Access items refer to the top-level resources that the security access review's target principal has access to."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, a top-level resource can be an app, hence the access item describes the principal's access to that app."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1378","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters access items."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"FilterByName":{"summary":"Filter by name","value":"name co \"Git\""},"FilterByPriority":{"summary":"Filter by priority","value":"priority eq \"HIGH\""},"FilterBySODConflict":{"summary":"Filter by sodConflictSeverity","value":"sodConflictSeverity eq \"HIGH\""},"FilterByAssignmentMethod":{"summary":"Filter by assignmentMethodSeverity","value":"assignmentMethodSeverity eq \"HIGH\""},"FilterByPastGovernanceDecisions":{"summary":"Filter by pastGovernanceDecisionsSeverity","value":"pastGovernanceDecisionsSeverity eq \"HIGH\""},"FilterByUsageHistory":{"summary":"Filter by usageHistorySeverity","value":"usageHistorySeverity eq \"HIGH\""},"FilterByGovernanceLabel":{"summary":"Filter by governanceLabel","value":"governanceLabel co \"Crown Jewel\""}}},{"name":"orderBy","in":"query","schemaId":"schema_1412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The field to sort the results, in ascending (asc) or descending (desc) order. Sorting is applied to only one field."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}]}],"examples":{"OrderByPriority":{"summary":"Order by priority","value":"priority desc"},"OrderByLastAccess":{"summary":"Order by lastAccess","value":"lastAccess desc"},"OrderByAccessFrequency":{"summary":"Order by accessFrequency","value":"accessFrequency desc"}}},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"filter","in":"query","required":false,"example":"name co \"Git\"","schemaId":"schema_1378"},{"name":"orderBy","in":"query","required":false,"example":"priority desc","schemaId":"schema_1412","style":"form","explode":false},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses","href":"security-access-reviews/listsecurityaccessreviewaccesses","openApiOperationId":"listSecurityAccessReviewAccesses","summary":"List the access items for a security access review"},"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 security access review access items get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/200/content/application~1json/examples/List access items in a security access review response"]}},"schemaId":"components/schemas/security-access-review-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/200/content/application~1json/examples/List access items in a security access review response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/200/content/application~1json/examples/List access items in a security access review response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/200/content/application~1json/examples/List access items in a security access review response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses"},{"label":"List the sub-access items for an access item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewsubaccesses","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewsubaccesses","metadata":{"seo":{"title":"List the sub-access items for an access item","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSecurityAccessReviewSubAccesses","name":"List the sub-access items for an access item","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the sub-access items for an access item","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the sub-access items for an access item from a security access review."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A sub-access item refers to the access of a resource that is a part of a top-level resource in an access item."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, an access item can describe the access of app, and the sub-access items can describe the access of groups, entitlement values, or entitlement bundles that belong to the app."},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true},{"name":"securityAccessReviewAccessId","in":"path","schemaId":"schema_1378","description":"The ID of the access item in a security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"filter","in":"query","schemaId":"schema_1378","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/#filter"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"filter"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" expression that filters sub-access items."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"examples":{"FilterByName":{"summary":"Filter by name","value":"name co \"Git\""},"FilterByResourceType":{"summary":"Filter by resourceType","value":"resourceType eq \"GROUP\""},"FilterByPriority":{"summary":"Filter by priority","value":"priority eq \"HIGH\""},"FilterBySODConflict":{"summary":"Filter by sodConflictSeverity","value":"sodConflictSeverity eq \"HIGH\""},"FilterByAssignmentMethod":{"summary":"Filter by assignmentMethodSeverity","value":"assignmentMethodSeverity eq \"HIGH\""},"FilterByPastGovernanceDecisions":{"summary":"Filter by pastGovernanceDecisionsSeverity","value":"pastGovernanceDecisionsSeverity eq \"HIGH\""},"FilterByUsageHistory":{"summary":"Filter by usageHistorySeverity","value":"usageHistorySeverity eq \"HIGH\""},"FilterByGovernanceLabel":{"summary":"Filter by governanceLabel","value":"governanceLabel co \"Crown Jewel\""}}},{"name":"orderBy","in":"query","schemaId":"schema_1412","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A field by which results can be sorted. For now, sorting by a single field is supported."},"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.mozilla.org/en-US/docs/Glossary/Percent-encoding"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Percent-encoding"},"children":[]}]}]}]}],"examples":{"OrderByPriority":{"summary":"Order by priority","value":"priority desc"}}},{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewAccessId}/sub-accesses","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"securityAccessReviewAccessId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"filter","in":"query","required":false,"example":"name co \"Git\"","schemaId":"schema_1378"},{"name":"orderBy","in":"query","required":false,"example":"priority desc","schemaId":"schema_1412","style":"form","explode":false},{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewAccessId}/sub-accesses","href":"security-access-reviews/listsecurityaccessreviewsubaccesses","openApiOperationId":"listSecurityAccessReviewSubAccesses","summary":"List the sub-access items for an access item"},"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 security access review access items get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-sub-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/200/content/application~1json/examples/List of sub-access items response"]}},"schemaId":"components/schemas/security-access-review-sub-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/200/content/application~1json/examples/List of sub-access items response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review-sub-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/200/content/application~1json/examples/List of sub-access items response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-sub-access-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/200/content/application~1json/examples/List of sub-access items response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewAccessId}/sub-accesses"},{"label":"List the anomalies for an access item","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccessesanomalies","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewaccessesanomalies","metadata":{"seo":{"title":"List the anomalies for an access item","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSecurityAccessReviewAccessesAnomalies","name":"List the anomalies for an access item","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the anomalies for an access item","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the anomalies for an access item"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true},{"name":"securityAccessReviewTargetId","in":"path","schemaId":"schema_1378","description":"The ID of the access or sub-access item in a security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/anomalies","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"securityAccessReviewTargetId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/anomalies","href":"security-access-reviews/listsecurityaccessreviewaccessesanomalies","openApiOperationId":"listSecurityAccessReviewAccessesAnomalies","summary":"List the anomalies for an access item"},"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 security access review anomalies get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-anomalies","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/200/content/application~1json/examples/Response for access item anomolies"]}},"schemaId":"components/schemas/security-access-review-anomalies","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/200/content/application~1json/examples/Response for access item anomolies"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review-anomalies","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/200/content/application~1json/examples/Response for access item anomolies"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-anomalies","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/200/content/application~1json/examples/Response for access item anomolies"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/anomalies"},{"label":"Generate a summary for an access item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewaccessessummary","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/generatesecurityaccessreviewaccessessummary","metadata":{"seo":{"title":"Generate a summary for an access item","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"generateSecurityAccessReviewAccessesSummary","name":"Generate a summary for an access item","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a summary for an access item","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Generates a summary for an access item in a security access review"},"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":"Notes:"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/iga/openapi/governance.api/tag/Org-Governance-Settings/#tag/Org-Governance-Settings/operation/updateOrgSettings!path=governanceAI&t=request"},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"governanceAI.securityAccessReview.enabled"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" org governance setting must be enabled for users to generate summaries for security access reviews."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This feature is excluded from the Okta for AI Agents - Core SKU, which is the version of Okta for AI Agents available to FedRAMP Moderate and FedRAMP High customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta for AI Agents - Core isn't available in Okta for US Military cells. For a current list of features that are excluded from the Okta for AI Agents - Core SKU, please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.okta.com/help/s/article/okta-us-public-sector-limitations-or-exceptions?language=en_US"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta US Public Sector Limitations or Exceptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documentation."},"children":[]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true},{"name":"securityAccessReviewTargetId","in":"path","schemaId":"schema_1378","description":"The ID of the access or sub-access item in a security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/summary","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"securityAccessReviewTargetId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/summary","href":"security-access-reviews/generatesecurityaccessreviewaccessessummary","openApiOperationId":"generateSecurityAccessReviewAccessesSummary","summary":"Generate a summary for an access item"},"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 security access review summary response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"]}},"schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/ai-message","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response","paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/summary"},{"label":"Execute an action on an access item","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaccessesaction","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/executesecurityaccessreviewaccessesaction","metadata":{"seo":{"title":"Execute an action on an access item","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"executeSecurityAccessReviewAccessesAction","name":"Execute an action on an access item","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Execute an action on an access item","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Executes an action on an access or sub-access item in a security access review"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true},{"name":"securityAccessReviewTargetId","in":"path","schemaId":"schema_1378","description":"The ID of the access or sub-access item in a security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-accesses-action-request"}},"schemaId":"components/schemas/security-access-review-accesses-action-request","pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/actions","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"},{"name":"securityAccessReviewTargetId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/security-access-review-accesses-action-request"}},"responseCodes":["202","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/actions","href":"security-access-reviews/executesecurityaccessreviewaccessesaction","openApiOperationId":"executeSecurityAccessReviewAccessesAction","summary":"Execute an action on an access item"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/security-access-review-accesses-action-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-accesses-action-request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"Action initiated successfully"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/actions"},{"label":"List the history of a security access review","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewhistory","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/listsecurityaccessreviewhistory","metadata":{"seo":{"title":"List the history of a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.readAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listSecurityAccessReviewHistory","name":"List the history of a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List the history of a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists the history of actions and changes for a specific security access review"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"after","in":"query","schemaId":"schema_1379","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the pagination cursor for the next page of results."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Treat this as an opaque value obtained through the standard link headers. 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":"."},"children":[]}]}]}]},{"name":"limit","in":"query","schemaId":"schema_1380","description":"The maximum number of records returned in a response"}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/history","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[{"name":"after","in":"query","required":false,"example":"00u68w6vzKLultXS97g6","schemaId":"schema_1379"},{"name":"limit","in":"query","required":false,"schemaId":"schema_1380"}],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/history","href":"security-access-reviews/listsecurityaccessreviewhistory","openApiOperationId":"listSecurityAccessReviewHistory","summary":"List the history of a security access review"},"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 security access review history get response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-history-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/200/content/application~1json/examples/History of a security access review response"]}},"schemaId":"components/schemas/security-access-review-history-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/200/content/application~1json/examples/History of a security access review response"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/security-access-review-history-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/200/content/application~1json/examples/History of a security access review response"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/security-access-review-history-items","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/200/content/application~1json/examples/History of a security access review response"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/history"},{"label":"Add a comment for a security access review","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/security-access-reviews/addsecurityaccessreviewcomment","routeSlug":"/iga/openapi/governance-production-reference/security-access-reviews/addsecurityaccessreviewcomment","metadata":{"seo":{"title":"Add a comment for a security access review","description":"OAuth 2.0 scope:okta.governance.securityAccessReviews.admin.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.securityAccessReviews.admin.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"addSecurityAccessReviewComment","name":"Add a comment for a security access review","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a comment for a security access review","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.governance.securityAccessReviews.admin.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":"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/permissions","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":"Permissions:"},"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.governance.securityAccessReviews.admin.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Adds a comment for a specific security access review"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"securityAccessReviewId","in":"path","schemaId":"schema_1378","description":"The ID of the security access review","required":true}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-comment-request"}},"schemaId":"components/schemas/security-access-review-comment-request","pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/comment","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"securityAccessReviewId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/security-access-review-comment-request"}},"responseCodes":["204","401","403","404","429","500"],"pointer":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/comment","href":"security-access-reviews/addsecurityaccessreviewcomment","openApiOperationId":"addSecurityAccessReviewComment","summary":"Add a comment for a security access review"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/security-access-review-comment-request","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/security-access-review-comment-request"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"Comment added successfully"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/comment"}],"content":{"contentType":"group","meta":{"name":"Security Access Reviews"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Security Access Reviews","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 Security Access Reviews API allows admins to manage security access reviews. These reviews provide a holistic view of a principal's access to resources, such as apps, groups, and entitlements. Designated reviewers can assess the target principal's access to resources and take immediate action. Security access reviews are typically triggered as a response to a security or policy evaluation event. Therefore, they’re time-sensitive and require prompt attention from reviewers."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v2/security-access-reviews","summary":"List all security access reviews","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/listsecurityaccessreviews","deprecated":false},{"title":"/governance/api/v2/security-access-reviews","summary":"Create a security access review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/security-access-reviews/createsecurityaccessreview","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/stats","summary":"Retrieve the statistics for security access reviews","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/getsecurityaccessreviewsstats","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}","summary":"Retrieve a security access review","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/getsecurityaccessreview","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}","summary":"Update a security access review","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/security-access-reviews/updatesecurityaccessreview","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/summary","summary":"Generate a summary for a security access review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/security-access-reviews/generatesecurityaccessreviewsummary","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions","summary":"List the actions for a security access review","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/listsecurityaccessreviewactions","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/actions","summary":"Execute an action on a security access review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/security-access-reviews/executesecurityaccessreviewaction","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/principal","summary":"Retrieve the principal for a security access review","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/getsecurityaccessreviewprincipaldetails","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses","summary":"List the access items for a security access review","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/listsecurityaccessreviewaccesses","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewAccessId}/sub-accesses","summary":"List the sub-access items for an access item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/listsecurityaccessreviewsubaccesses","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/anomalies","summary":"List the anomalies for an access item","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/listsecurityaccessreviewaccessesanomalies","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/summary","summary":"Generate a summary for an access item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/security-access-reviews/generatesecurityaccessreviewaccessessummary","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/accesses/{securityAccessReviewTargetId}/actions","summary":"Execute an action on an access item","prefix":{"name":"post","color":"post"},"badges":[],"link":"/security-access-reviews/executesecurityaccessreviewaccessesaction","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/history","summary":"List the history of a security access review","prefix":{"name":"get","color":"get"},"badges":[],"link":"/security-access-reviews/listsecurityaccessreviewhistory","deprecated":false},{"title":"/governance/api/v2/security-access-reviews/{securityAccessReviewId}/comment","summary":"Add a comment for a security access review","prefix":{"name":"post","color":"post"},"badges":[],"link":"/security-access-reviews/addsecurityaccessreviewcomment","deprecated":false}]}]}]}]}},{"type":"group","label":"Org Governance Settings","link":"/iga/openapi/governance-production-reference/org-governance-settings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings","items":[{"label":"Retrieve the org settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/getorgsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/getorgsettings","metadata":{"seo":{"title":"Retrieve the org settings","description":"BetaOAuth 2.0 scope:okta.governance.settings.readAdmin roles:ACCESS_CERTIFICATION_ADMINACCESS_REQUESTS_ADMINSUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrgSettings","name":"Retrieve the org settings","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the org 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":"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.governance.settings.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":"ACCESS_CERTIFICATION_ADMIN"},"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":"ACCESS_REQUESTS_ADMIN"},"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 governance settings for the org"},"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 must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPER_ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role to retrieve governance settings for the org."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/settings","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","429","500"],"pointer":"/governance/api/v1/settings","href":"org-governance-settings/getorgsettings","openApiOperationId":"getOrgSettings","summary":"Retrieve the org 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":"A successful org settings response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-settings","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"]}},"schemaId":"components/schemas/org-settings","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/org-settings","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-settings","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/settings"},{"label":"Update the org settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgsettings","metadata":{"seo":{"title":"Update the org settings","description":"BetaOAuth 2.0 scope:okta.governance.settings.manageAdmin roles:SUPER_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrgSettings","name":"Update the org settings","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the org 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":"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.governance.settings.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 the governance settings for the org"},"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 must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPER_ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role to update the org settings."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can assign their manager or peers as delegates"]}},"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can assign their manager or peers as delegates"],"pointer":"/paths/~1governance~1api~1v1~1settings/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/settings","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can assign their manager or peers as delegates"]}},"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/settings","href":"org-governance-settings/updateorgsettings","openApiOperationId":"updateOrgSettings","summary":"Update the org settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can assign their manager or peers as delegates"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can assign their manager or peers as delegates"]}},"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 org settings response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"]}},"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate","paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/settings"},{"label":"List all org integrations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/listorgintegrations","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/listorgintegrations","metadata":{"seo":{"title":"List all org integrations","description":"BetaOAuth 2.0 scope:okta.governance.settings.readAdmin roles:ACCESS_CERTIFICATION_ADMINACCESS_REQUESTS_ADMINSUPER_ADMINPermissions:okta.governance.settings.read"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"listOrgIntegrations","name":"List all org integrations","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List all org integrations","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.governance.settings.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":"ACCESS_CERTIFICATION_ADMIN"},"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":"ACCESS_REQUESTS_ADMIN"},"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":"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/permissions","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":"Permissions:"},"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.governance.settings.read"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Lists all governance org integrations"},"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 must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPER_ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.governance.settings.read"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to retrieve org integrations for the org."},"children":[]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/settings/integrations","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","429","500"],"pointer":"/governance/api/v1/settings/integrations","href":"org-governance-settings/listorgintegrations","openApiOperationId":"listOrgIntegrations","summary":"List all org integrations"},"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 org integrations response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integrations-readable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations in progress","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations connected","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations failed"]}},"schemaId":"components/schemas/integrations-readable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations in progress","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations connected","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations failed"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/integrations-readable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations in progress","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations connected","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations failed"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integrations-readable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations in progress","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations connected","paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations failed"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/settings/integrations"},{"label":"Create an org integration","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/createorgintegration","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/createorgintegration","metadata":{"seo":{"title":"Create an org integration","description":"BetaOAuth 2.0 scope:okta.governance.settings.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.settings.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"createOrgIntegration","name":"Create an org integration","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create an org integration","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.governance.settings.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":"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/permissions","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":"Permissions:"},"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.governance.settings.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Creates a governance org integration"},"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 must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPER_ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.governance.settings.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to create a governance org integration."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integration-creatable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody/content/application~1json/examples/Create Slack integration"]}},"schemaId":"components/schemas/integration-creatable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody/content/application~1json/examples/Create Slack integration"],"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/governance/api/v1/settings/integrations","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/integration-creatable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody/content/application~1json/examples/Create Slack integration"]}},"responseCodes":["201","400","401","403","429","500"],"pointer":"/governance/api/v1/settings/integrations","href":"org-governance-settings/createorgintegration","openApiOperationId":"createOrgIntegration","summary":"Create an org integration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/integration-creatable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody/content/application~1json/examples/Create Slack integration"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/integration-creatable","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody/content/application~1json/examples/Create Slack integration"]}},"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 org integrations response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integration-full","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/201/content/application~1json/examples/Slack integration in progress"]}},"schemaId":"components/schemas/integration-full","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/201/content/application~1json/examples/Slack integration in progress"],"headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/integration-full","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/201/content/application~1json/examples/Slack integration in progress"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/integration-full","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/201/content/application~1json/examples/Slack integration in progress"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations/post/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/settings/integrations"},{"label":"Delete an org integration","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/deleteorgintegration","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/deleteorgintegration","metadata":{"seo":{"title":"Delete an org integration","description":"BetaOAuth 2.0 scope:okta.governance.settings.manageAdmin roles:SUPER_ADMINPermissions:okta.governance.settings.manage"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"deleteOrgIntegration","name":"Delete an org integration","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete an org integration","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.governance.settings.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":"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/permissions","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":"Permissions:"},"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.governance.settings.manage"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Deletes a governance org integration"},"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 must have the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPER_ADMIN"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" role or the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"okta.governance.settings.manage"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" permission to delete the governance org integration."},"children":[]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"integrationId","in":"path","schemaId":"schema_1378","description":"Unique identifier for the integration","required":true}],"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/governance/api/v1/settings/integrations/{integrationId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"integrationId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["204","400","401","403","429","500"],"pointer":"/governance/api/v1/settings/integrations/{integrationId}","href":"org-governance-settings/deleteorgintegration","openApiOperationId":"deleteOrgIntegration","summary":"Delete an org integration"},"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":"A successful org settings integration delete response","headers":{"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1377"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/settings/integrations/{integrationId}"},{"label":"Retrieve the org certification settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/getorgcertificationsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/getorgcertificationsettings","metadata":{"seo":{"title":"Retrieve the org certification settings","description":"BetaOAuth 2.0 scope:okta.governance.admin.readAdmin roles:ACCESS_CERTIFICATION_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOrgCertificationSettings","name":"Retrieve the org certification settings","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1settings~1certification/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the org certification 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":"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.governance.admin.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":"ACCESS_CERTIFICATION_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves the access certification settings for the org"},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/settings/certification","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/settings/certification","href":"org-governance-settings/getorgcertificationsettings","openApiOperationId":"getOrgCertificationSettings","summary":"Retrieve the org certification 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":"A successful org certification settings response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-certification-settings","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/200/content/application~1json/examples/Notifications are enabled for all supported integrations"]}},"schemaId":"components/schemas/org-certification-settings","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/200/content/application~1json/examples/Notifications are enabled for all supported integrations"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1settings~1certification/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/org-certification-settings","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/200/content/application~1json/examples/Notifications are enabled for all supported integrations"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-certification-settings","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/200/content/application~1json/examples/Notifications are enabled for all supported integrations"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/settings/certification"},{"label":"Update the org certification settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgcertificationsettings","routeSlug":"/iga/openapi/governance-production-reference/org-governance-settings/updateorgcertificationsettings","metadata":{"seo":{"title":"Update the org certification settings","description":"BetaOAuth 2.0 scope:okta.governance.admin.manageAdmin roles:ACCESS_CERTIFICATION_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateOrgCertificationSettings","name":"Update the org certification settings","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1settings~1certification/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the org certification 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":"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.governance.admin.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":"ACCESS_CERTIFICATION_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates the access certification settings for the org"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody/content/application~1json/examples/Certification notification settings for the org"]}},"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody/content/application~1json/examples/Certification notification settings for the org"],"pointer":"/paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v1/settings/certification","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody/content/application~1json/examples/Certification notification settings for the org"]}},"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v1/settings/certification","href":"org-governance-settings/updateorgcertificationsettings","openApiOperationId":"updateOrgCertificationSettings","summary":"Update the org certification settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody/content/application~1json/examples/Certification notification settings for the org"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody/content/application~1json/examples/Certification notification settings for the org"]}},"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 org certification settings response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/200/content/application~1json/examples/Certification notification settings for the org"]}},"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/200/content/application~1json/examples/Certification notification settings for the org"],"headers":{"Link":{"$ref":"#/components/headers/link"},"X-Rate-Limit-Limit":{"$ref":"#/components/headers/rate-limit-limit"},"X-Rate-Limit-Remaining":{"$ref":"#/components/headers/rate-limit-remaining"},"X-Rate-Limit-Reset":{"$ref":"#/components/headers/rate-limit-reset"}},"headerSchemaId":"schema_1382"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1settings~1certification/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/200/content/application~1json/examples/Certification notification settings for the org"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/org-certification-settings-patchable","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/200/content/application~1json/examples/Certification notification settings for the org"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1settings~1certification/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/settings/certification"}],"content":{"contentType":"group","meta":{"name":"Org Governance Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Org Governance Settings","showPageActions":true},{"nodeType":"markdoc","content":"The Org Governance Settings API allows admins to manage governance settings for their org. Use this API to manage settings for an org, such as whether end users can manage delegates."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/settings","summary":"Retrieve the org settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/org-governance-settings/getorgsettings","deprecated":false},{"title":"/governance/api/v1/settings","summary":"Update the org settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/org-governance-settings/updateorgsettings","deprecated":false},{"title":"/governance/api/v1/settings/integrations","summary":"List all org integrations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/org-governance-settings/listorgintegrations","deprecated":false},{"title":"/governance/api/v1/settings/integrations","summary":"Create an org integration","prefix":{"name":"post","color":"post"},"badges":[],"link":"/org-governance-settings/createorgintegration","deprecated":false},{"title":"/governance/api/v1/settings/integrations/{integrationId}","summary":"Delete an org integration","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/org-governance-settings/deleteorgintegration","deprecated":false},{"title":"/governance/api/v1/settings/certification","summary":"Retrieve the org certification settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/org-governance-settings/getorgcertificationsettings","deprecated":false},{"title":"/governance/api/v1/settings/certification","summary":"Update the org certification settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/org-governance-settings/updateorgcertificationsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Entitlement Settings","link":"/iga/openapi/governance-production-reference/entitlement-settings","routeSlug":"/iga/openapi/governance-production-reference/entitlement-settings","items":[{"label":"Update the entitlement settings for the resource","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-settings/updateentitlementsettings","routeSlug":"/iga/openapi/governance-production-reference/entitlement-settings/updateentitlementsettings","metadata":{"seo":{"title":"Update the entitlement settings for the resource","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.manageAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"updateEntitlementSettings","name":"Update the entitlement settings for the resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the entitlement settings for the resource","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Updates entitlement settings for a resource"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resourceOrn","in":"path","schemaId":"schema_1378","description":"The resource ORN","required":true}],"pointer":"/paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-settings-updatable","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management"]}},"schemaId":"components/schemas/entitlement-settings-updatable","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management"],"pointer":"/paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody","description":"The updatable attributes of the entitlement settings"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"resourceOrn","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"requestBody":{"application/json":{"schemaId":"components/schemas/entitlement-settings-updatable","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management"]}},"responseCodes":["202","400","401","403","404","429","500"],"pointer":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings","href":"entitlement-settings/updateentitlementsettings","openApiOperationId":"updateEntitlementSettings","summary":"Update the entitlement settings for the resource"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"schemaId":"components/schemas/entitlement-settings-updatable","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/entitlement-settings-updatable","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management"]}},"examples":[{},{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A successful entitlement settings update operation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-settings-full"}},"schemaId":"components/schemas/entitlement-settings-full"},{"code":"400","description":"An invalid request to update the entitlement settings","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/entitlement-settings-full","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-settings-full"}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings"},{"label":"Retrieve the entitlement settings for the resource","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/entitlement-settings/getentitlementsettings","routeSlug":"/iga/openapi/governance-production-reference/entitlement-settings/getentitlementsettings","metadata":{"seo":{"title":"Retrieve the entitlement settings for the resource","description":"BetaOAuth 2.0 scope:okta.governance.entitlements.readAdmin roles:APP_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getEntitlementSettings","name":"Retrieve the entitlement settings for the resource","isWebhook":false,"pointer":"/paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve the entitlement settings for the resource","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.governance.entitlements.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":"APP_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves entitlement settings for the resource"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"resourceOrn","in":"path","schemaId":"schema_1378","description":"The resource ORN","required":true}],"pointer":"/paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"resourceOrn","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","401","403","404","429","500"],"pointer":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings","href":"entitlement-settings/getentitlementsettings","openApiOperationId":"getEntitlementSettings","summary":"Retrieve the entitlement settings for the resource"},"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","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-settings-full","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource"]}},"schemaId":"components/schemas/entitlement-settings-full","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource"]},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/403/content/application~1json/example"]},{"code":"404","description":"The requested resource wasn't found error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/404/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/404/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/entitlement-settings-full","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/entitlement-settings-full","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource","paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource"]}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/403/content/application~1json/example"]}}},{"code":"404","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/404/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/404/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings"}],"content":{"contentType":"group","meta":{"name":"Entitlement Settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Entitlement Settings","showPageActions":true},{"nodeType":"markdoc","content":"The Entitlement Settings API allows you to read and update entitlement-related settings for resources."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings","summary":"Update the entitlement settings for the resource","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/entitlement-settings/updateentitlementsettings","deprecated":false},{"title":"/governance/api/v2/resources/{resourceOrn}/entitlement-settings","summary":"Retrieve the entitlement settings for the resource","prefix":{"name":"get","color":"get"},"badges":[],"link":"/entitlement-settings/getentitlementsettings","deprecated":false}]}]}]}]}},{"type":"group","label":"Operations","link":"/iga/openapi/governance-production-reference/operations","routeSlug":"/iga/openapi/governance-production-reference/operations","items":[{"label":"Retrieve an operation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/iga/openapi/governance-production-reference/operations/getoperation","routeSlug":"/iga/openapi/governance-production-reference/operations/getoperation","metadata":{"seo":{"title":"Retrieve an operation","description":"BetaOAuth 2.0 scope:okta.governance.operations.readAdmin roles:ORG_ADMIN"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"getOperation","name":"Retrieve an operation","isWebhook":false,"pointer":"/paths/~1governance~1api~1v1~1operations~1{operationId}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve an 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.governance.operations.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":"ORG_ADMIN"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieves an operation and its status"},"children":[]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"operationId","in":"path","schemaId":"schema_1378","description":"ID of the operation","required":true}],"pointer":"/paths/~1governance~1api~1v1~1operations~1{operationId}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/governance/api/v1/operations/{operationId}","servers":[{"url":"https://{yourOktaDomain}","variables":{"yourOktaDomain":{"default":"subdomain.okta.com"}}}],"parameters":{"path":[{"name":"operationId","in":"path","required":true,"schemaId":"schema_1378"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[],"responseCodes":["200","400","401","403","429","500"],"pointer":"/governance/api/v1/operations/{operationId}","href":"operations/getoperation","openApiOperationId":"getOperation","summary":"Retrieve an 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":"A successful response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/operation","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Operation in RUNNING status"]}},"schemaId":"components/schemas/operation","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Operation in RUNNING status"],"headers":{"Link":{"$ref":"#/components/headers/link"}},"headerSchemaId":"schema_1413"},{"code":"400","description":"A request failed validation","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}},"schemaId":"components/schemas/error"},{"code":"401","description":"Authentication fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]},{"code":"403","description":"Authorization fails error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/example"]},{"code":"429","description":"The rate limit has been exceeded error response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/example"]},{"code":"500","description":"Error response when a server fault occurs due to an unexpected error","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/500/content/application~1json/example"]}},"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/500/content/application~1json/example"]}],"pointer":"/paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/operation","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Operation in RUNNING status"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/operation","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Operation in RUNNING status"]}}},{"code":"400","schemaId":"components/schemas/error","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error"}}},{"code":"401","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."]}}},{"code":"403","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/example"]}}},{"code":"429","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/example"]}}},{"code":"500","schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/500/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/error","exampleIds":["paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/500/content/application~1json/example"]}}}],"examples":[]}]}]}]},"httpPath":"/governance/api/v1/operations/{operationId}"}],"content":{"contentType":"group","meta":{"name":"Operations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"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 Operations API allows you to retrieve details on asynchronous governance operations. The URI for the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/iga/openapi/governance-production-reference/operations/getoperation"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Retrieve an operation"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" request is found in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response of the governance API that initiate these asynchronous operations."},"children":[]}]}]}]}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/governance/api/v1/operations/{operationId}","summary":"Retrieve an operation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/operations/getoperation","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/okta-id":{"id":"components/schemas/okta-id","kind":"json-schema","title":"okta-id","data":{"description":"The Okta ID","type":"string","maxLength":20,"minLength":20,"example":"00u1a2b3c4d5e6f7g8h9"}},"components/schemas/created-by":{"id":"components/schemas/created-by","kind":"json-schema","title":"created-by","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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Okta user who created the resource"},"children":[]}]}]}],"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"readOnly":true,"minLength":1,"maxLength":20,"format":"okta-user-id"}},"components/schemas/created":{"id":"components/schemas/created","kind":"json-schema","title":"created","data":{"description":"The ISO 8601 formatted date and time when the resource was created","type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"date-time","readOnly":true}},"components/schemas/last-updated":{"id":"components/schemas/last-updated","kind":"json-schema","title":"last-updated","data":{"description":"The ISO 8601 formatted date and time when the object was last updated","type":"string","format":"date-time","readOnly":true}},"components/schemas/last-updated-by":{"id":"components/schemas/last-updated-by","kind":"json-schema","title":"last-updated-by","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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Okta user who last updated the object"},"children":[]}]}]}],"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"readOnly":true,"minLength":1,"maxLength":20,"format":"okta-user-id"}},"components/schemas/link":{"id":"components/schemas/link","kind":"json-schema","title":"link","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"A link to a related RESTful resource","required":["href"],"properties":{"name":{"type":"string","description":"Link name"},"rel":{"type":"string","description":"Link relation"},"href":{"type":"string","minLength":1,"description":"Link URI"},"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's implicitly "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"application/json"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"method":{"type":"string","deprecated":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":[]}]}]}]},"hints":{"type":"object","description":"Link hints","additionalProperties":{"type":"array","items":{"type":"string"}}},"title":{"type":"string","description":"Link title or label"}}}},"components/schemas/read-only-standard-properties":{"id":"components/schemas/read-only-standard-properties","kind":"json-schema","title":"read-only-standard-properties","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","createdBy","created","lastUpdated","lastUpdatedBy"],"properties":{"id":{"description":"Unique identifier for the object","type":"string","minLength":1},"createdBy":{"$ref":"#/components/schemas/created-by"},"created":{"$ref":"#/components/schemas/created"},"lastUpdated":{"$ref":"#/components/schemas/last-updated"},"lastUpdatedBy":{"$ref":"#/components/schemas/last-updated-by"},"_links":{"type":"object","description":"Links to related resources","additionalProperties":{"$ref":"#/components/schemas/link"}}}}},"components/schemas/campaign-status":{"id":"components/schemas/campaign-status","kind":"json-schema","title":"campaign-status","data":{"type":"string","enum":["SCHEDULED","LAUNCHING","ACTIVE","COMPLETED","DELETED","ERROR"]}},"components/schemas/campaign-read-only-fields":{"id":"components/schemas/campaign-read-only-fields","kind":"json-schema","title":"campaign-read-only-fields","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Read-only attributes","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/campaign-status"}}}},"components/schemas/schedule-type":{"id":"components/schemas/schedule-type","kind":"json-schema","title":"schedule-type","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The type of campaign","enum":["ONE_OFF","RECURRING"]}},"components/schemas/campaign-reviewer-type":{"id":"components/schemas/campaign-reviewer-type","kind":"json-schema","title":"campaign-reviewer-type","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Identifies the type of reviewer for the access certification campaign","enum":["USER","REVIEWER_EXPRESSION","GROUP","RESOURCE_OWNER","MULTI_LEVEL"],"x-enumDescriptions":{"USER":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single reviewer reviews the campaign. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required for this reviewer type."},"children":[]}]}]}],"REVIEWER_EXPRESSION":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies an expression to derive a reviewer for the campaign. This reviewer type is typically used for the manager reviewer use case ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the user's manager). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.fallBackReviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required and is used if Okta can't determine the reviewer based on the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"GROUP":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the members of an Okta group specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the reviewers for the campaign. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required for this reviewer type. If the group specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains only one member, then that member is assigned as the reviewer for all reviews, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those reviews. When the campaign launches, if the group has more than 10 members, 10 members from the group are randomly set as reviewers for the campaign."},"children":[]}]}]}],"RESOURCE_OWNER":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource owners are the reviewers for the campaign. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.fallBackReviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required and is set as the reviewer if resource owners aren't found or are unsupported for the resource. If resource owners are configured, the reviewers are derived from owners of the resources specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"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":" For certifying AD groups, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fallBackReviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always used because resource owners for AD groups aren't supported."},"children":[]}]}]}],"MULTI_LEVEL":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A campaign with reviews that can be reviewed and passed on from a reviewer at one level to a reviewer at the next level. This setting provides a sequence of reviewers who can decide on the final outcome of the reviews. A maximum of two reviewer levels are supported. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required, and all other properties in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are ignored."},"children":[]}]}]}]}}},"components/schemas/campaign-links":{"id":"components/schemas/campaign-links","kind":"json-schema","title":"campaign-links","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Links available on a single campaign representation.","required":["reviews","self"],"properties":{"launchCampaign":{"$ref":"#/components/schemas/link"},"endCampaign":{"$ref":"#/components/schemas/link"},"reviews":{"$ref":"#/components/schemas/link"},"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/campaign-sparse":{"id":"components/schemas/campaign-sparse","kind":"json-schema","title":"campaign-sparse","data":{"description":"Sparse representation of a Campaign resource.\n","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"$ref":"#/components/schemas/campaign-read-only-fields"}],"required":["name","startDate","endDate","scheduleType","reviewerType","_links"],"properties":{"name":{"type":"string","description":"Name of the campaign. Maintain some uniqueness when naming the campaign as it helps to identify and filter for campaigns when needed.","minLength":1,"maxLength":255},"description":{"type":"string","description":"Campaign description","maxLength":1000},"startDate":{"type":"string","description":"The date on which the campaign is scheduled to start. Accepts date in ISO 8601 format.","format":"date-time"},"endDate":{"type":"string","description":"The date on which the campaign is supposed to end. Accepts date in ISO 8601 format.","format":"date-time"},"scheduleType":{"description":"Specify the type of the campaign to be created. A campaign could one off or recurring.","$ref":"#/components/schemas/schedule-type"},"recurringCampaignId":{"type":"string","description":"ID of the recurring campaign if this campaign was created as part of a recurring schedule.","nullable":true,"minLength":1,"maxLength":20},"reviewerType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specify the type of the reviewers. Reviewers can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_OWNER"},"children":[]}]}]}],"$ref":"#/components/schemas/campaign-reviewer-type"},"_links":{"allOf":[{"$ref":"#/components/schemas/campaign-links"}]}}}},"components/schemas/campaigns-list-links":{"id":"components/schemas/campaigns-list-links","kind":"json-schema","title":"campaigns-list-links","data":{"type":"object","description":"Links available in campaign list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/campaigns-list":{"id":"components/schemas/campaigns-list","kind":"json-schema","title":"campaigns-list","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["data","_links"],"properties":{"data":{"type":"array","description":"Sparse representation of a Campaign resource.\n","items":{"$ref":"#/components/schemas/campaign-sparse","minItems":0}},"_links":{"$ref":"#/components/schemas/campaigns-list-links"}}}},"components/schemas/error-cause":{"id":"components/schemas/error-cause","kind":"json-schema","title":"error-cause","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"A specific cause of an error","required":["errorSummary"],"properties":{"errorSummary":{"type":"string","description":"A more specific summary for the error that contains the error cause"},"reason":{"type":"string","description":"An enumerated value to represent the reason why the error occurred. This enumeration allows codes to adapt to different conditions in which an error code can occur."},"location":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A value that represents the key where the error cause occurred. This is used with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to give a holistic view of where the error cause occurred. For example, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"locationType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"body"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"location"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"username"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reason"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"UNIQUE_CONSTRAINT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you can derive that the username was already taken."},"children":[]}]}]}]},"locationType":{"type":"string","description":"A value that represents where the error cause occurred. For example, in the body or header of the request. This value isn't required for cases where the request is correct, but there was another reason why the error occurred (server-side state conflict, rate limit violation, and so on)."},"domain":{"type":"string","description":"A value that represents the domain of the service in which the error occurs. This value is used to isolate the error cause reason."}}}},"components/schemas/error":{"id":"components/schemas/error","kind":"json-schema","title":"error","data":{"type":"object","description":"An Error object","required":["errorCode","errorId","errorSummary"],"properties":{"errorCode":{"type":"string","description":"An error code unique to the error"},"errorId":{"type":"string","description":"An error identifier useful for troubleshooting an error with support"},"errorSummary":{"type":"string","description":"An error code description detailing the error"},"errorLink":{"type":"string","description":"An indicator of where to look to troubleshoot the error"},"errorCauses":{"type":"array","description":"An optional array of string values that explain possible reasons for the error","items":{"$ref":"#/components/schemas/error-cause"}}}}},"components/schemas/campaign-type":{"id":"components/schemas/campaign-type","kind":"json-schema","title":"campaign-type","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the campaign as a resource ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") or an identity ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") campaign"},"children":[]}]}]}],"default":"RESOURCE","enum":["RESOURCE","USER"],"x-enumDescriptions":{"RESOURCE":"Certify access to resources in a campaign","USER":"Certify access for an identity (user or AI agent) in a campaign"}}},"components/schemas/recurrence-repeat-on-type":{"id":"components/schemas/recurrence-repeat-on-type","kind":"json-schema","title":"recurrence-repeat-on-type","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable only, if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in terms of N months. Specifies the day-of-the-month on which, the campaign should be repeated. If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is in terms of days, weeks or years, this property can be ignored."},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_DAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Specifies the day-of-the-month in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For eg: if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"5th"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of some date, then campaign will repeat on 5th day of the matching month."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SAME_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Specifies the day-of-the-week in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For eg if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then campaign will repeat on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the matching week."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"LAST_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - Specifies the last day-of-the-week in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For eg jf "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and it is the last week of the month, then campaign will repeat on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the matching last week."},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer few examples below:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"June 1st 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P3M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 3 months) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: SAME_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"- the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be in the first week, and it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"3 months"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first week's Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jun  1st, Thursday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sep  7th, Thursday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Dec  7th, Thursday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"June 1st 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: SAME_DAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1st"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" day of the month. Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1st day of the month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jun  1st, Thursday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jul  1st, Saturday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aug  1st, Tuesday,   2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"June 1st 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: SAME_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be in the first week, and it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"first week's Thursday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jun  1st, Thursday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jul  6th, Thursday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aug  3rd, Thursday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"May 23rd 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: SAME_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be in the fourth week, and it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Tuesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fourth week's Tuesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May  23rd, Tuesday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jun  27th, Tuesday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jul  25th, Tuesday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aug  22nd, Tuesday,  2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"May 29rd 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: LAST_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" - the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be in the last week, and it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Monday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last week's Monday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"May  29th, Monday,   2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jun  26th, Monday,   2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jul  31st, Monday,   2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"4"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aug  28th, Monday,   2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"June 28th 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: SAME_DAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"28th"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" day of the month. Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"28th day of the month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jun 28th, Wednesday, 2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jul 28th, Friday,    2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aug 28th, Monday,    2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"June 28th 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: LAST_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be the last week of the month, and it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wednesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last week's Wednesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jun 28th, Wednesday, 2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jul 26th, Wednesday, 2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Aug 30th, Wednesday, 2023"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jan 31st 2024"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: LAST_WEEKDAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be the last week of the month, and it is a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wednesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"last week's Wednesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jan 31st, Wednesday, 2024"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feb 28th, Wednesday, 2024"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mar 27th, Wednesday, 2024"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Let's say the campaign start date is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jan 31st 2024"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval: P1M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 1 month) and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOnType: SAME_DAY_AS_START_DATE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" -  the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31st"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" day of the month. Hence the campaign will repeat every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"1 month"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and will start on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"31st"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"30th"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"28/29th"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"(for February). In this example, some sample campaign occurrences are below -"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Campaign No"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Date of recurrence"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"1"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Jan 31st, Wednesday, 2024"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Feb 29th, Thursday,  2024"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"3"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Mar 31st, Sunday,    2024"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"..."},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[]}]}]}]}]}]}]}],"type":"string","enum":["SAME_DAY_AS_START_DATE","SAME_WEEKDAY_AS_START_DATE","LAST_WEEKDAY_AS_START_DATE"]}},"components/schemas/recurrence-definition-mutable":{"id":"components/schemas/recurrence-definition-mutable","kind":"json-schema","title":"recurrence-definition-mutable","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Applicable for recurring campaigns only ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type: RECURRING"},"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 specify the campaign recurring frequency using "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"repeatOn"},"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":"Optionally specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ends"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" with a date-time, when the campaign schedule can end."},"children":[]}]}]}],"required":["interval"],"properties":{"interval":{"type":"string","format":"duration","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurrence interval specified according to ISO8061 notation for durations."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Refer https://tc39.es/proposal-temporal/docs/duration.html for all supported values."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Recurring campaigns support - daily, weekly, monthly and yearly interval."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"One can setup a \"interval\" to max of -"},"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":"182 days (That is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P182D"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"26 weeks (equivalent of 182 days, that is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P26W"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"24 months (That is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P24M"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"2 years (That is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P2Y"},"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":"Few examples to better understand, how "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is used."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"June 28th 2023"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the intent is to repeat the campaign -"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":")"},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every 25 days, specify \"P25D\"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every 4 weeks specify \"P4W\". In this example the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" happens to be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wednesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the campaign would run every "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Wednesday"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of 4th week of the month."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every 3 months specify \"P3M\". In this example the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is on 28th day. Hence, campaigns repeats every 3 months on 28th day."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Every 2 years specify \"P2Y\". In this example, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"startDate"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jun 28"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". Hence repeats every 2 yrs on "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Jun 28th"},"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":"Also note that, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"interval"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" should not conflict "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"durationInDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For eg: If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"durationInDays"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified as 21 days, but interval is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"P2W"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" (Every 2 weeks), it becomes an invalid request, as duration of the campaign conflicts with the next recurrence of the campaign."},"children":[]}]}]}],"example":"P3M"},"repeatOnType":{"$ref":"#/components/schemas/recurrence-repeat-on-type","example":"SAME_WEEKDAY_AS_START_DATE"},"ends":{"type":"string","format":"date-time","description":"An optional field. Specifies when the recurring schedule can have an end. If not specified, the recurring schedule will run forever."}}}},"components/schemas/schedule-settings-mutable":{"id":"components/schemas/schedule-settings-mutable","kind":"json-schema","title":"schedule-settings-mutable","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduler specific settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A campaign can be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONE_OFF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" campaign."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can't provide both in the campaign definition."},"children":[]}]}]}],"required":["type","startDate","durationInDays","timeZone"],"properties":{"type":{"description":"Specify the type of the campaign to be created. A campaign could one off or recurring.","$ref":"#/components/schemas/schedule-type"},"startDate":{"type":"string","description":"The date on which the campaign is supposed to start. Accepts date in ISO 8601 format.","format":"date-time"},"durationInDays":{"type":"number","minimum":1,"description":"The duration (in days) that the campaign is active."},"timeZone":{"type":"string","description":"The time zone, in IANA format, for the start date of the campaign.","minLength":1,"maxLength":64},"recurrence":{"$ref":"#/components/schemas/recurrence-definition-mutable"}}}},"components/schemas/campaign-resource-type":{"id":"components/schemas/campaign-resource-type","kind":"json-schema","title":"campaign-resource-type","data":{"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 Okta resources certified by the campaign."},"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":" Okta recommends that you use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to indicate Okta resources to certify for new certification campaigns instead of this parameter."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the examples."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for certifying all supported resources for new campaigns."},"children":[]}]}]}]}],"enum":["GROUP","APPLICATION","APPLICATION_AND_GROUP","OKTA_SERVICE_ACCOUNT","APP_SERVICE_ACCOUNT","COLLECTION"],"x-enumDescriptions":{"GROUP":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certify groups for resource campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"APPLICATION":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certify apps, including entitlements and bundles, for resource campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"APPLICATION_AND_GROUP":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certify both apps and groups for user campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"OKTA_SERVICE_ACCOUNT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certify Okta service accounts for resource campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"APP_SERVICE_ACCOUNT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Certify SaaS app service accounts for resource campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}],"COLLECTION":[{"$$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":"ea"}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Certify collections for resource campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")."},"children":[]}]}]}]}}},"components/schemas/resource-target-type":{"id":"components/schemas/resource-target-type","kind":"json-schema","title":"resource-target-type","data":{"type":"string","enum":["GROUP","APPLICATION","APP_SERVICE_ACCOUNT","OKTA_SERVICE_ACCOUNT","COLLECTION","AI_AGENT_CONNECTION"],"description":"The type of Okta resource to target","x-enumDescriptions":{"GROUP":"Group resource","APPLICATION":"App resource","APP_SERVICE_ACCOUNT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App service account (only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"OKTA_SERVICE_ACCOUNT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta service accounts (only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"COLLECTION":[{"$$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":"ea"}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Collection resource"},"children":[]}]}]}],"AI_AGENT_CONNECTION":"AI Agent connections"}}},"components/schemas/resource-type":{"id":"components/schemas/resource-type","kind":"json-schema","title":"resource-type","data":{"type":"string","enum":["GROUP","APPLICATION","GOVERNANCE_LABEL_VALUE","APP_SERVICE_ACCOUNT","OKTA_SERVICE_ACCOUNT","COLLECTION"],"description":"The type of Okta resource","x-enumDescriptions":{"GROUP":"Group resource","APPLICATION":"App resource","GOVERNANCE_LABEL_VALUE":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Governance label resource for resource campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). Used in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"target.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property"},"children":[]}]}]}],"APP_SERVICE_ACCOUNT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App service account (only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"OKTA_SERVICE_ACCOUNT":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta service accounts (only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"COLLECTION":[{"$$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":"ea"}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Collection resource"},"children":[]}]}]}]}}},"components/schemas/entitlement-bundles":{"id":"components/schemas/entitlement-bundles","kind":"json-schema","title":"entitlement-bundles","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and entitlement management is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of entitlement bundles (associated with the app specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") selected as targets for review."},"children":[]}]}]}],"items":{"type":"object","minItems":1,"required":["id"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entitlement bundle "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":1,"maxLength":20}}}}},"components/schemas/entitlement-value":{"id":"components/schemas/entitlement-value","kind":"json-schema","title":"entitlement-value","data":{"type":"object","description":"List of entitlement value IDs","required":["id"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entitlement value "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":1,"maxLength":20}}}},"components/schemas/entitlements":{"id":"components/schemas/entitlements","kind":"json-schema","title":"entitlements","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and entitlement management is enabled."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of entitlements (associated with the app specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") selected as targets for review."},"children":[]}]}]}],"items":{"type":"object","required":["id"],"minItems":1,"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entitlement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":1,"maxLength":20},"includeAllValues":{"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 to include all entitlement 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":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all entitlement values are included."},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", you must specify the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}]}]},"values":{"type":"array","description":"Entitlement value IDs","minItems":1,"items":{"$ref":"#/components/schemas/entitlement-value"}}}}}},"components/schemas/governance-label-values":{"id":"components/schemas/governance-label-values","kind":"json-schema","title":"governance-label-values","data":{"type":"array","description":[{"$$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":"beta"}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"targetResources.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GOVERNANCE_LABEL_VALUE"},"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 list of governance label values assigned to resources to target for the review."},"children":[]}]}]}],"items":{"type":"object","minItems":1,"required":["id"],"properties":{"id":{"type":"string","description":"The ID of the governance label","minLength":1,"maxLength":20}}}}},"components/schemas/app-service-accounts":{"id":"components/schemas/app-service-accounts","kind":"json-schema","title":"app-service-accounts","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"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 list of app service accounts (associated with the app specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") selected as targets for review."},"children":[]}]}]}],"items":{"type":"object","minItems":1,"required":["id"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The app service account "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":1,"maxLength":36}}}}},"components/schemas/target-resources-request":{"id":"components/schemas/target-resources-request","kind":"json-schema","title":"target-resources-request","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specific resources that are included in the access certification campaign:"},"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":"resourceSettings.targetResources.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and the app is enabled with entitlement management, you can also review entitlements and entitlement bundles:"},"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":"Review all entitlements and bundles by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.includeAllEntitlementsAndBundles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set by default)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restrict the review to non-policy entitlement grants by setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.onlyIncludeOutOfPolicyEntitlements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set by default)."},"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":"resourceSettings.targetResources.includeAllEntitlementsAndBundles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then you must specify a list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.entitlementBundles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and/or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.entitlements"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"resourceSettings.targetTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OKTA_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OKTA_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the ID of the Okta service account."},"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":"resourceSettings.targetTypes"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" includes "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APP_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the ID of the Okta app instance, and add service account IDs into "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.appServiceAccounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"items":{"type":"object","description":"A resource that's included in the access certification campaign","required":["resourceId"],"properties":{"resourceId":{"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 ID to review. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" value depends on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" object."},"children":[]}]}]}],"minLength":1,"maxLength":36},"resourceType":{"$ref":"#/components/schemas/resource-type"},"includeAllEntitlementsAndBundles":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and entitlement management is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include all entitlements and entitlement bundles for the app."},"children":[]}]}]}]},"entitlementBundles":{"$ref":"#/components/schemas/entitlement-bundles"},"entitlements":{"$ref":"#/components/schemas/entitlements"},"entitlementValueScopeByGovernanceLabelValues":{"$ref":"#/components/schemas/governance-label-values"},"includeBundlesHavingSameEntitlementValues":{"type":"boolean","description":[{"$$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":"beta"}},"children":[]},{"$$mdtype":"Node","type":"tag","tag":"html","inline":true,"attributes":{"name":"br","attrs":{}},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", entitlements bundles are also included as additional targets to review."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only entitlement bundles with values that are targeted through the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementValueScopeByGovernanceLabelValues"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list are included."},"children":[]}]}]}]},"entitlementBundleScopeByGovernanceLabelValues":{"$ref":"#/components/schemas/governance-label-values"},"appServiceAccounts":{"$ref":"#/components/schemas/app-service-accounts"},"includeAllAppServiceAccounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APP_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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 true, includes all SaaS app service accounts associated with the app specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If false, includes only the SaaS app service accounts specified in the list of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.appServiceAccounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The list of service account IDs in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.appServiceAccounts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must be associated with the app in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}}}}},"components/schemas/resource-type-exclude":{"id":"components/schemas/resource-type-exclude","kind":"json-schema","title":"resource-type-exclude","data":{"type":"string","enum":["GROUP","APPLICATION","COLLECTION"],"description":"The type of Okta resource to exclude","x-enumDescriptions":{"GROUP":"Group resource","APPLICATION":"App resource","COLLECTION":[{"$$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":"ea"}},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" Collection resource"},"children":[]}]}]}]}}},"components/schemas/resource-settings-mutable":{"id":"components/schemas/resource-settings-mutable","kind":"json-schema","title":"resource-settings-mutable","data":{"type":"object","description":"Resource specific properties","properties":{"type":{"$ref":"#/components/schemas/campaign-resource-type"},"targetTypes":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Include the list of resource types to be certified in this campaign."},"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":"Identity campaigns ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType=USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") support more than one resource type in the list."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource campaigns support one resource type per campaign. See examples for details."},"children":[]}]}]}]}],"items":{"$ref":"#/components/schemas/resource-target-type"}},"targetResources":{"$ref":"#/components/schemas/target-resources-request"},"excludedResources":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"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 list of resources that are excluded from the review."},"children":[]}]}]}],"items":{"type":"object","description":"A resource that's excluded from the user campaign","properties":{"resourceId":{"type":"string","description":"Okta specific resource ID","minLength":1,"maxLength":20},"resourceType":{"$ref":"#/components/schemas/resource-type-exclude"}}}},"individuallyAssignedAppsOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only include individually assigned apps."},"children":[]}]}]}],"type":"boolean"},"individuallyAssignedGroupsOnly":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only include individually assigned groups."},"children":[]}]}]}],"type":"boolean"},"includeEntitlements":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and entitlement management is enabled."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include entitlements for the app."},"children":[]}]}]}],"default":false},"onlyIncludeOutOfPolicyEntitlements":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and entitlement management is enabled:"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only include out-of-policy entitlements."},"children":[]}]}]}]},"includeAdminRoles":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"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":"If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", include users assigned to admin roles in the campaign."},"children":[]}]}]}]},"includeAllOktaServiceAccounts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only applicable when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"OKTA_SERVICE_ACCOUNT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", all Okta service accounts in the org are included as target resources in the campaign."},"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":"false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only the Okta service accounts IDs specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources.resourceId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are included in the campaign."},"children":[]}]}]}]}]}}}},"components/schemas/principal-scope-type":{"id":"components/schemas/principal-scope-type","kind":"json-schema","title":"principal-scope-type","data":{"type":"string","enum":["USERS","AI_AGENTS"],"x-enumDescriptions":{"USERS":"User as principal","AI_AGENTS":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"AI agent as principal (only for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}]}}},"components/schemas/predefined-inactive-users-scope-settings":{"id":"components/schemas/predefined-inactive-users-scope-settings","kind":"json-schema","title":"predefined-inactive-users-scope-settings","data":{"type":"object","additionalProperties":false,"properties":{"inactiveDays":{"description":"The duration the users have not used single sign on (SSO) to access their account within the specific time frame. Minimum 30 days and maximum 365 days are supported.","type":"integer","minimum":30,"maximum":365}}}},"components/schemas/principal-scope-settings-mutable":{"id":"components/schemas/principal-scope-settings-mutable","kind":"json-schema","title":"principal-scope-settings-mutable","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The principal identity scope for campaigns."},"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":"For resource campaigns (when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), if all users aren't part of the certification scope, then provide the scope of the users with a user expression in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For identity campaigns (when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), you must specify either "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groupIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aiAgentIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" properties to define the scope of identities for the campaign."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it must be a valid Okta expression that evaluates to a list of users."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If you specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groupIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"aiAgentIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the campaign includes only those principal identities."},"children":[]}]}]}]}],"required":["type"],"properties":{"type":{"description":"Identifies the kind of principal that is in scope for access certification. An example is the scoped principal can be a user","$ref":"#/components/schemas/principal-scope-type"},"userScopeExpression":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta expression language user expression on the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to include users in the campaign."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":7000},"excludedUserIds":{"type":"array","description":"An array of Okta user IDs excluded from access certification or the campaign. This field is optional. A maximum of 50 users can be specified in the array.","items":{"type":"string","format":"okta-user-id","minLength":1,"maxLength":20}},"userIds":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of Okta user IDs included from access certification or the campaign. This list is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and you want to certify user access. A maximum of 100 users can be specified in the array."},"children":[]}]}]}],"nullable":true,"items":{"type":"string","format":"okta-user-id","minLength":1,"maxLength":20}},"groupIds":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An array of Okta group IDs included from access certification or the campaign. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groupIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"userScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is required if campaign type is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A maximum of 5 groups can be specified in the array."},"children":[]}]}]}],"nullable":true,"items":{"type":"string","format":"okta-group-id","minLength":1,"maxLength":20}},"includeOnlyActiveUsers":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only active Okta users are included in the campaign"},"children":[]}]}]}]},"predefinedInactiveUsersScope":{"description":"Identifies the duration the users have not used single sign on (SSO) to access their account within the specific time frame. Minimum 30 days and maximum 365 days are supported.","$ref":"#/components/schemas/predefined-inactive-users-scope-settings"},"onlyIncludeUsersWithSODConflicts":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", only includes users that have at least one SOD conflict that was caused due to entitlement(s) within Campaign scope"},"children":[]}]}]}]},"aiAgentIds":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of Okta registered AI agent IDs included in the campaign."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This list is required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and you want to certify AI agents."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can specify up to a maximum of 100 AI agent IDs."},"children":[]}]}]}],"nullable":true,"items":{"type":"string","minLength":1,"maxLength":20}}}}},"components/schemas/reviewer-type":{"id":"components/schemas/reviewer-type","kind":"json-schema","title":"reviewer-type","data":{"type":"string","description":"Identifies the type of reviewer at this level for the campaign","enum":["USER","REVIEWER_EXPRESSION","GROUP","RESOURCE_OWNER"],"x-enumDescriptions":{"USER":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A single reviewer reviews the campaign. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.reviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required for this reviewer type."},"children":[]}]}]}],"REVIEWER_EXPRESSION":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies an expression to derive a reviewer for the campaign. This reviewer type is typically used for the manager reviewer use case ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates the user's manager). The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.fallBackReviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required, and is used if Okta can't determine the reviewer based on the required "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property."},"children":[]}]}]}],"GROUP":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"All the members of an Okta group specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.reviewerGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are the reviewers for the campaign. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.reviewerGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required for this reviewer type. If the group specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.reviewerGroupId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" contains only one member, then that member is assigned as the reviewer for all reviews, and the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those reviews. When the campaign launches, if the group has more than 10 members, 10 members from the group are randomly set as reviewers for the campaign."},"children":[]}]}]}],"RESOURCE_OWNER":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource owners are the reviewers for the campaign. The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.fallBackReviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is required and is set as the reviewer if resource owners aren't found or are unsupported for the resource. If resource owners are configured, the reviewers are derived from owners of the resources specified in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceSettings.targetResources"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}},"components/schemas/reviewer-lower-level-condition":{"id":"components/schemas/reviewer-lower-level-condition","kind":"json-schema","title":"reviewer-lower-level-condition","data":{"description":"The condition for reviews to move from the first to the second level reviewer.\n\nDon't set a condition for the first level. A condition is only appropriate for the second level.\n","type":"string","enum":["LOWER_LEVEL_APPROVES","LOWER_LEVEL_APPROVES_OR_REJECTS"],"x-enumDescriptions":{"LOWER_LEVEL_APPROVES":"Only approved reviews from the lower level moves to this level.","LOWER_LEVEL_APPROVES_OR_REJECTS":"Both approved and revoked reviews from the lower level moves to this level."}}},"components/schemas/reviewer-level-start-review":{"id":"components/schemas/reviewer-level-start-review","kind":"json-schema","title":"reviewer-level-start-review","data":{"type":"object","description":"Indicates rules for starting reviews at this level\n","required":["onDay"],"properties":{"onDay":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The day when reviewer level starts:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the first level, this value is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" since the first level starts when the campaign starts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the second level, specify a value that's greater than "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"0"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This indicates the day when the reviews move to the second level."},"children":[]}]}]}]}],"type":"integer","default":0},"when":{"$ref":"#/components/schemas/reviewer-lower-level-condition"}}}},"components/schemas/reviewer-level-settings-mutable":{"id":"components/schemas/reviewer-level-settings-mutable","kind":"json-schema","title":"reviewer-level-settings-mutable","data":{"type":"object","required":["type","startReview"],"properties":{"type":{"$ref":"#/components/schemas/reviewer-type"},"startReview":{"$ref":"#/components/schemas/reviewer-level-start-review"},"reviewerId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property is required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of an Okta user to assign all reviews. Use this reviewer type when you can't specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":20,"format":"okta-user-id"},"reviewerScopeExpression":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVIEWER_EXPRESSION"},"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":"The Okta-specific user expression to fetch the reviewers from a connected identity source:"},"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 a user is found with the provided expression, that user is assigned as the reviewer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a user isn't found with the provided expression, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"fallBackReviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user is assigned as the reviewer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/reference/okta-expression-language/#okta-user-profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Expression Language (EL)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to build the expression based on user profile attributes."},"children":[]}]}]}]}],"minLength":1,"maxLength":2000},"fallBackReviewerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when reviewer setting "},"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":"REVIEWER_EXPRESSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_OWNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The fallback reviewer is assigned as the reviewer if:"},"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":"reviewer setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fails to identify reviewers, or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reviewers aren't identified through resource owners"},"children":[]}]}]}]}],"minLength":1,"maxLength":20,"format":"okta-user-id"},"reviewerGroupId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.reviewerLevels.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Okta group:"},"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":"All members of the specified group are assigned as reviewers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this reviewer group assignment to assign more than one reviewer if you can't use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Okta group has more than 10 members when the campaign launches, only 10 members are randomly selected as reviewers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Okta group has only one member, then that member is assigned as the reviewer for all reviews, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those reviews."},"children":[]}]}]}]}],"type":"string","minLength":1,"maxLength":20,"format":"okta-user-id"},"isSelfReviewDisabled":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can't review their own review items."},"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 field is deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"selfReviewDisabled"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"type":"boolean"},"selfReviewDisabled":{"description":[{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can't review their own review items"},"children":[]}]}]}],"type":"boolean"}}}},"components/schemas/justification-requirement":{"id":"components/schemas/justification-requirement","kind":"json-schema","title":"justification-requirement","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Controls when justification is required for review decisions."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For resource campaigns that have the Okta Admin Console as one of the resources, this property must be one of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIRED_FOR_ALL"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIRED_FOR_REVOKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REQUIRED_FOR_REVOKE_OPTIONAL_FOR_APPROVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["OPTIONAL","REQUIRED_FOR_REVOKE","REQUIRED_FOR_REVOKE_OPTIONAL_FOR_APPROVE","REQUIRED_FOR_ALL","DISABLED"],"x-enumDescriptions":{"OPTIONAL":"Justification dialog appears for both approve and revoke decisions, but it isn't a mandatory field.","REQUIRED_FOR_REVOKE":"Justification is required only for revoke decisions. No justification dialog appears for an approve decision.","REQUIRED_FOR_REVOKE_OPTIONAL_FOR_APPROVE":"A justification dialog appears for both approve and revoke decisions, but only the revocation reason is required.","REQUIRED_FOR_ALL":"Justification is required for both approve and revoke decisions.","DISABLED":"Justification dialog isn't shown for any decision."}}},"components/schemas/reviewer-settings-mutable":{"id":"components/schemas/reviewer-settings-mutable","kind":"json-schema","title":"reviewer-settings-mutable","data":{"type":"object","description":"Reviewer settings for the access certification campaign\n","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/campaign-reviewer-type"},"reviewerId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"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":"The ID of an Okta user to assign all reviews."},"children":[]}]}]}],"type":"string","minLength":1,"maxLength":20,"format":"okta-user-id"},"reviewerScopeExpression":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVIEWER_EXPRESSION"},"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":"The Okta-specific user expression to fetch the reviewers from a connected identity source:"},"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 a user is found with the provided expression, that user is assigned as the reviewer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If a user isn't found with the provided expression, the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.fallBackReviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" user is assigned as the reviewer."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/reference/okta-expression-language/#okta-user-profile"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta Expression Language (EL)"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to build the expression base on user profile attributes."},"children":[]}]}]}]}],"minLength":1,"maxLength":2000,"example":"user.profile.managerId"},"fallBackReviewerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when reviewer setting "},"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":"REVIEWER_EXPRESSION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_OWNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". The fallback reviewer is assigned as the reviewer if:"},"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":"reviewer setting "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" fails to identify reviewers, or"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"reviewers aren't identified through resource owners"},"children":[]}]}]}]}],"minLength":1,"maxLength":20,"format":"okta-user-id"},"reviewerGroupId":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Required when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerSettings.type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the Okta group:"},"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":"All members of the specified group are assigned as reviewers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this reviewer group assignment if you can't use "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerScopeExpression"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Okta group has more than 10 members when the campaign launches, only 10 members are randomly selected as reviewers."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the Okta group has only one member, then that member is assigned as the reviewer for all reviews, and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for those reviews."},"children":[]}]}]}]}],"type":"string","minLength":1,"maxLength":20,"format":"okta-user-id"},"isSelfReviewDisabled":{"deprecated":true,"description":[{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can't review their own review items."},"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 field is deprecated. Use "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"/iga/openapi/governance-production-reference/campaigns/createcampaign#campaigns/createcampaign/t=request&path=reviewersettings/selfreviewdisabled"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'selfReviewDisabled'"},"children":[]}]}]}]}]}],"type":"boolean"},"selfReviewDisabled":{"description":[{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can't review their own review items"},"children":[]}]}]}],"type":"boolean"},"justificationRequired":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If true, a justification is required when review items are approved or revoked."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This property must be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for resource campaigns that have the Okta Admin Console as one of the resources."},"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":" Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"justificationRequirement"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property to control review justification for all new campaigns instead of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"justificationRequired"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". This property provides you with more control over your review justification settings."},"children":[]}]}]}]}]},"bulkDecisionDisabled":{"description":"If true, bulk actions are disabled for approving or revoking review items.\n","type":"boolean"},"reassignmentDisabled":{"description":"If true, reassignment is disabled for reviewers.\n","type":"boolean"},"reviewerLevels":{"description":"Defines the reviewer level in a campaign. A campaign can have a maximum of two reviewer levels.\n","type":"array","items":{"$ref":"#/components/schemas/reviewer-level-settings-mutable"},"minItems":2,"maxItems":2},"justificationRequirement":{"$ref":"#/components/schemas/justification-requirement"}}}},"components/schemas/notification-settings":{"id":"components/schemas/notification-settings","kind":"json-schema","title":"notification-settings","data":{"type":"object","description":"Settings for email notifications to be sent to the reviewers at different stages of a campaign. All properties are optional.","properties":{"notifyReviewerWhenReviewAssigned":{"description":"A Boolean value to indicate whether a notification should be sent to the reviewer when actionable reviews are assigned","type":"boolean","default":false},"notifyReviewerAtCampaignEnd":{"type":"boolean","description":"A Boolean value to indicate whether a notification should be sent to the reviewers when the campaign has come to an end","default":false},"remindersReviewerBeforeCampaignCloseInSecs":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies, in seconds, the time a reminder is sent to reviewers before the campaign closes. You can send up to three notifications"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For example, this array "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"[86400, 172800, 604800]"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" sends reminder notifications seven days, two days, and one day before the campaign closes."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"By default, reminders are sent two days and one day before the campaign closes."},"children":[]}]}]}],"minItems":1,"maxItems":3,"items":{"type":"integer"},"default":[86400,172800]},"notifyReviewerWhenOverdue":{"description":"A Boolean value to indicate whether a notification is sent to the reviewer when reviews are overdue","type":"boolean","nullable":true,"default":false},"notifyReviewerDuringMidpointOfReview":{"description":"A Boolean value to indicate whether a notification should be sent to the reviewer during the midpoint of the review process","type":"boolean","nullable":true,"default":false},"notifyReviewPeriodEnd":{"description":"Applicable for multi-level campaigns. A Boolean value to indicate whether a notification is sent to the reviewer when a given reviewer level period is about to end","type":"boolean","nullable":true,"default":false}}}},"components/schemas/approved-remediation-action":{"id":"components/schemas/approved-remediation-action","kind":"json-schema","title":"approved-remediation-action","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the action by default if the reviewer approves access. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_ACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that there's no remediation action and the user retains access."},"children":[]}]}]}],"enum":["NO_ACTION"],"default":"NO_ACTION"}},"components/schemas/revoked-remediation-action":{"id":"components/schemas/revoked-remediation-action","kind":"json-schema","title":"revoked-remediation-action","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the action if the reviewer revokes access. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_ACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the user retains the same access. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DENY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the user's access is revoked as long as they aren't assigned to a group through Group Rules."},"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 a user is assigned to a resource by way of a group and the campaign is targeted to users assigned directly to the app, the user's access isn't revoked and the review is flagged as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Manual Intervention required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If the same campaign is configured to use the Enhanced Group Remediation, and the group the user is assigned to is included in the campaign, the user's access is revoked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is assigned through Group Rules and a campaign attempts to remove the user from the group, the user's access isn't revoked and the review is flagged as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Manual Intervention required"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}],"enum":["NO_ACTION","DENY"],"default":"NO_ACTION"}},"components/schemas/no-response-remediation-action":{"id":"components/schemas/no-response-remediation-action","kind":"json-schema","title":"no-response-remediation-action","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the action if the reviewer doesn't respond to the request or if the campaign is closed before an action is taken. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"NO_ACTION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that there's no remediation action taken, and the user retains the same access. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DENY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" indicates that the user's access is revoked when the campaign ends as long as they're not assigned to a group through Group Rules."},"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 a user is assigned to a resource by way of a group, and the campaign is targeted to users assigned directly to the app, the user isn't revoked and the review is flagged as “Manual Intervention required”. If the same campaign is configured to use the Enhanced Group Remediation, and the group the user is assigned to is included in the campaign, the user is revoked."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the user is assigned through Group Rules and a campaign attempts to remove the user from the group, the user isn't removed and the review is flagged as “Manual Intervention required”."},"children":[]}]}]}]}],"enum":["NO_ACTION","DENY"],"default":"NO_ACTION"}},"components/schemas/auto-remediation-resource-type":{"id":"components/schemas/auto-remediation-resource-type","kind":"json-schema","title":"auto-remediation-resource-type","data":{"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 resource to be automatically remediated. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is supported."},"children":[]}]}]}],"enum":["GROUP"]}},"components/schemas/auto-remediation-settings":{"id":"components/schemas/auto-remediation-settings","kind":"json-schema","title":"auto-remediation-settings","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When a group is selected to be automatically remediated, if a user is assigned to an app through this group,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"the user is automatically removed from the group if their access to the app is revoked in the Access Certification Campaign."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Group"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is currently the only supported type of resource that can be automatically remediated."},"children":[]}]}]}],"properties":{"includeOnly":{"type":"array","description":"An array of resources to be automatically remediated","minItems":0,"items":{"type":"object","description":"Represents a list of resources that are automatically remediated","properties":{"resourceType":{"$ref":"#/components/schemas/auto-remediation-resource-type"},"resourceId":{"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 target resource."},"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":"resourceType = GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", it points to the group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"minLength":1,"maxLength":20}}}},"includeAllIndirectAssignments":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","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":"includeAllIndirectAssignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", the user's access to all groups that can assign the user to the app(s) is removed during remediation. Only app assignments through groups can be automatically remediated."},"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 specify only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeAllIndirectAssignments"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"includeOnly"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}]}}}},"components/schemas/remediation-settings":{"id":"components/schemas/remediation-settings","kind":"json-schema","title":"remediation-settings","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the action to be taken after a reviewer makes a decision to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPROVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVOKE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" the access, or if the campaign was "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CLOSED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and there was no response from the reviewer"},"children":[]}]}]}],"required":["accessApproved","accessRevoked","noResponse"],"properties":{"accessApproved":{"$ref":"#/components/schemas/approved-remediation-action"},"accessRevoked":{"$ref":"#/components/schemas/revoked-remediation-action"},"noResponse":{"$ref":"#/components/schemas/no-response-remediation-action"},"autoRemediationSettings":{"description":"Specifies which resources can be automatically remediated","$ref":"#/components/schemas/auto-remediation-settings"}}}},"components/schemas/campaign-tier":{"id":"components/schemas/campaign-tier","kind":"json-schema","title":"campaign-tier","data":{"type":"string","description":"Indicates the minimum required SKU to manage the campaign","enum":["BASIC","PREMIUM"]}},"components/schemas/reporting-settings-mutable":{"id":"components/schemas/reporting-settings-mutable","kind":"json-schema","title":"reporting-settings-mutable","data":{"type":"object","description":"Reporting properties for processing post-completed campaigns","properties":{"createReportingPackageEnabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","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":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", a post-campaign reporting package is created"},"children":[]}]}]}],"default":false}}}},"components/schemas/campaign-mutable":{"id":"components/schemas/campaign-mutable","kind":"json-schema","title":"campaign-mutable","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"There are two "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"campaignType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" types. RESOURCE: Campaigns created focused on certain resources USER: Campaigns created focused on certain users"},"children":[]}]}]}],"required":["name","scheduleSettings","resourceSettings","reviewerSettings","remediationSettings"],"properties":{"name":{"type":"string","description":"Name of the campaign. Maintain some uniqueness when naming the campaign as it helps to identify and filter for campaigns when needed.","minLength":1,"maxLength":255},"description":{"type":"string","description":"Campaign description","maxLength":1000},"campaignType":{"$ref":"#/components/schemas/campaign-type"},"scheduleSettings":{"$ref":"#/components/schemas/schedule-settings-mutable"},"resourceSettings":{"$ref":"#/components/schemas/resource-settings-mutable"},"principalScopeSettings":{"description":"An array of Okta specific resource id for which access is being reviewed.","$ref":"#/components/schemas/principal-scope-settings-mutable"},"reviewerSettings":{"$ref":"#/components/schemas/reviewer-settings-mutable"},"notificationSettings":{"$ref":"#/components/schemas/notification-settings"},"remediationSettings":{"$ref":"#/components/schemas/remediation-settings"},"campaignTier":{"$ref":"#/components/schemas/campaign-tier"},"reportingSettings":{"$ref":"#/components/schemas/reporting-settings-mutable"}}}},"components/schemas/schedule-settings-read-only":{"id":"components/schemas/schedule-settings-read-only","kind":"json-schema","title":"schedule-settings-read-only","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Scheduler specific settings."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A campaign can be a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ONE_OFF"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" campaign."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can't provide both in the campaign definition."},"children":[]}]}]}],"required":["type","startDate","durationInDays","timeZone"],"properties":{"type":{"description":"Specify the type of the campaign to be created. A campaign could one off or recurring.","$ref":"#/components/schemas/schedule-type"},"startDate":{"type":"string","description":"The date on which the campaign is supposed to start. Accepts date in ISO 8601 format.","format":"date-time"},"durationInDays":{"type":"number","minimum":0,"description":"The duration (in days) that the campaign is active."},"timeZone":{"type":"string","description":"The time zone, in IANA format, for the start date of the campaign.","minLength":1,"maxLength":64},"endDate":{"type":"string","description":"The date on which the campaign is supposed to end. Date in ISO 8601 format.","format":"date-time","readOnly":true},"recurrence":{"$ref":"#/components/schemas/recurrence-definition-mutable"}}}},"components/schemas/campaign-details-read-only":{"id":"components/schemas/campaign-details-read-only","kind":"json-schema","title":"campaign-details-read-only","data":{"type":"object","required":["name","scheduleSettings","resourceSettings","reviewerSettings","remediationSettings"],"properties":{"name":{"type":"string","description":"Name of the campaign. Maintain some uniqueness when naming the campaign as it helps to identify and filter for campaigns when needed.","minLength":1,"maxLength":255},"description":{"type":"string","description":"Human readable description","maxLength":1000},"campaignType":{"$ref":"#/components/schemas/campaign-type"},"scheduleSettings":{"$ref":"#/components/schemas/schedule-settings-read-only"},"resourceSettings":{"$ref":"#/components/schemas/resource-settings-mutable"},"principalScopeSettings":{"description":"An array of Okta specific resource id for which access is being reviewed.","$ref":"#/components/schemas/principal-scope-settings-mutable"},"reviewerSettings":{"$ref":"#/components/schemas/reviewer-settings-mutable"},"notificationSettings":{"$ref":"#/components/schemas/notification-settings"},"remediationSettings":{"$ref":"#/components/schemas/remediation-settings"},"recurringCampaignId":{"type":"string","description":"ID of the recurring campaign if this campaign was created as part of a recurring schedule.","nullable":true,"minLength":1,"maxLength":20},"reportingSettings":{"$ref":"#/components/schemas/reporting-settings-mutable"}}}},"components/schemas/campaign-full":{"id":"components/schemas/campaign-full","kind":"json-schema","title":"campaign-full","data":{"description":"Full representation of a Campaign resource","allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"$ref":"#/components/schemas/campaign-details-read-only"},{"$ref":"#/components/schemas/campaign-read-only-fields"}],"required":["_links"],"properties":{"_links":{"$ref":"#/components/schemas/campaign-links"}}}},"components/schemas/campaign-end-skip-remediation":{"id":"components/schemas/campaign-end-skip-remediation","kind":"json-schema","title":"campaign-end-skip-remediation","data":{"type":"object","description":"Boolean variable to skip remediation when campaign end operation is requested.","properties":{"skipRemediation":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Set the Boolean variable to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to skip remediation in cases where "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"remediationSetting.noResponse=DENY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}}}},"components/schemas/reviewer-entitlement":{"id":"components/schemas/reviewer-entitlement","kind":"json-schema","title":"reviewer-entitlement","data":{"type":"object","description":"Entitlement information","required":["id","name"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entitlement "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":1,"maxLength":20},"name":{"type":"string","description":"The entitlement display name","minLength":1,"maxLength":255},"externalValue":{"type":"string","description":"The value of the entitlement property","minLength":1,"maxLength":255}}}},"components/schemas/reviewer-entitlement-value":{"id":"components/schemas/reviewer-entitlement-value","kind":"json-schema","title":"reviewer-entitlement-value","data":{"type":"object","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":"Entitlement value. Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType = APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and Entitlement Management is enabled."},"children":[]}]}]}],"required":["id","name"],"properties":{"id":{"type":"string","description":"The entitlement value id","minLength":1,"maxLength":20},"name":{"type":"string","description":"The entitlement value display name","minLength":1,"maxLength":255},"externalValue":{"type":"string","description":"The value of the entitlement property value","minLength":1,"maxLength":2000},"entitlement":{"$ref":"#/components/schemas/reviewer-entitlement"}}}},"components/schemas/reviewer-entitlement-bundle":{"id":"components/schemas/reviewer-entitlement-bundle","kind":"json-schema","title":"reviewer-entitlement-bundle","data":{"type":"object","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":"Entitlement bundle. Only applicable if "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceType = APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and Entitlement Management is enabled."},"children":[]}]}]}],"required":["id","name"],"properties":{"id":{"type":"string","description":"The entitlement bundle id","minLength":1,"maxLength":20},"name":{"type":"string","description":"The entitlement bundle name","minLength":1,"maxLength":255}}}},"components/schemas/decision":{"id":"components/schemas/decision","kind":"json-schema","title":"decision","data":{"type":"string","description":"The decision for a review","x-okta-ignore-redocly-rules-for-sdk":true,"enum":["UNREVIEWED","APPROVE","REVOKE"]}},"components/schemas/remediation-status":{"id":"components/schemas/remediation-status","kind":"json-schema","title":"remediation-status","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"enum":["NONE","OPEN","ERROR","SUCCESS","MANUAL"]}},"components/schemas/principal-profile-status":{"id":"components/schemas/principal-profile-status","kind":"json-schema","title":"principal-profile-status","data":{"type":"string","description":"The status of the principal's profile","enum":["ACTIVE","INACTIVE"]}},"components/schemas/principal-profile-type":{"id":"components/schemas/principal-profile-type","kind":"json-schema","title":"principal-profile-type","data":{"type":"string","description":"The type of principal","enum":["USER","CLIENT_APP","UNKNOWN","AI_AGENT"]}},"components/schemas/principal-profile-enriched":{"id":"components/schemas/principal-profile-enriched","kind":"json-schema","title":"principal-profile-enriched","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"A limited set of properties from the principal's profile","required":["id","status","type"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta user "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":1,"maxLength":20},"email":{"type":"string","description":"Okta user's email address","minLength":1,"maxLength":100},"firstName":{"type":"string","description":"Okta user's first name","minLength":0,"maxLength":255},"lastName":{"type":"string","description":"Okta user's last name","minLength":0,"maxLength":255},"login":{"type":"string","description":"Okta user's sign-in credentials, which is often their email address","minLength":1,"maxLength":100},"name":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Principal's name (populated if "},"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":"AI_AGENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":")"},"children":[]}]}]}],"minLength":1,"maxLength":255},"status":{"$ref":"#/components/schemas/principal-profile-status"},"type":{"$ref":"#/components/schemas/principal-profile-type"}}}},"components/schemas/reviewers-reviewer-type":{"id":"components/schemas/reviewers-reviewer-type","kind":"json-schema","title":"reviewers-reviewer-type","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the reviewer type for the access certification. Reviewers can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_OWNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["USER","GROUP","RESOURCE_OWNER"]}},"components/schemas/group-type":{"id":"components/schemas/group-type","kind":"json-schema","title":"group-type","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The type of group. It is either 'GROUP' or 'RESOURCE_OWNER'."},"children":[]}]}]}],"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"enum":["GROUP","RESOURCE_OWNER"]}},"components/schemas/reviewer-group-profile":{"id":"components/schemas/reviewer-group-profile","kind":"json-schema","title":"reviewer-group-profile","data":{"type":"object","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":"Applicable only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"reviewerType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_OWNER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". For all other reviewer type, this property can be ignored."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"It represents the group in charge of reviews."},"children":[]}]}]}],"required":["name","groupId","groupType"],"properties":{"name":{"type":"string","minLength":0,"maxLength":255},"groupId":{"type":"string","minLength":1,"maxLength":36},"groupType":{"$ref":"#/components/schemas/group-type"}}}},"components/schemas/reviewer-level-type":{"id":"components/schemas/reviewer-level-type","kind":"json-schema","title":"reviewer-level-type","data":{"type":"string","description":"Identifies the reviewer level of each reviews during access certification. Applicable for multi level campaigns only.","enum":["FIRST","SECOND"]}},"components/schemas/review-links":{"id":"components/schemas/review-links","kind":"json-schema","title":"review-links","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Links available on a single review representation","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"reassignReview":{"$ref":"#/components/schemas/link"}}}},"components/schemas/review-entitlement":{"id":"components/schemas/review-entitlement","kind":"json-schema","title":"review-entitlement","data":{"type":"object","description":"Entitlement and it's entitlement values.","required":["id","name"],"properties":{"id":{"type":"string","description":"The entitlement id","minLength":1,"maxLength":20},"name":{"type":"string","description":"The entitlement name","minLength":1,"maxLength":255},"values":{"type":"array","description":"Collection of entitlement values.","maxItems":1000,"items":{"$ref":"#/components/schemas/reviewer-entitlement-value"}}}}},"components/schemas/risk-rule-criteria":{"id":"components/schemas/risk-rule-criteria","kind":"json-schema","title":"risk-rule-criteria","data":{"type":"object","properties":{"name":{"type":"string","nullable":false,"description":"The name of the risk rule criteria"},"operation":{"type":"string","nullable":false,"description":"Operation to be performed on the criteria value","enum":["CONTAINS_ONE","CONTAINS_ALL"]},"value":{"type":"object","properties":{"type":{"type":"string","nullable":false,"description":"The type of the criteria value","enum":["ENTITLEMENTS"]},"value":{"type":"array","description":"Collection of entitlements with associated values","nullable":false,"items":{"$ref":"#/components/schemas/review-entitlement"}}}}}}},"components/schemas/risk-rule-conflicts":{"id":"components/schemas/risk-rule-conflicts","kind":"json-schema","title":"risk-rule-conflicts","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"id":{"description":"Unique identifier of the risk rule","type":"string","minLength":1},"type":{"type":"string","nullable":false,"description":"The type of the rule","enum":["SEPARATION_OF_DUTIES"]},"conflictCriteria":{"type":"object","properties":{"and":{"type":"array","items":{"$ref":"#/components/schemas/risk-rule-criteria"},"minItems":2,"maxItems":2}}}}}},"components/schemas/reviewer-service-account":{"id":"components/schemas/reviewer-service-account","kind":"json-schema","title":"reviewer-service-account","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Service account information for reviewer","required":["id","name"],"properties":{"id":{"type":"string","description":"The service account ID","minLength":1,"maxLength":36},"name":{"type":"string","description":"The service account name","minLength":1,"maxLength":255}}}},"components/schemas/authorization-server-scope-condition":{"id":"components/schemas/authorization-server-scope-condition","kind":"json-schema","title":"authorization-server-scope-condition","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Scope condition defined for the authorization server","enum":["ALL_SCOPES","INCLUDE_ONLY","EXCLUDE"]}},"components/schemas/reviewer-ai-agent-connected-resource-authorization-server":{"id":"components/schemas/reviewer-ai-agent-connected-resource-authorization-server","kind":"json-schema","title":"reviewer-ai-agent-connected-resource-authorization-server","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Authorization server details for an AI agent connection","properties":{"orn":{"type":"string","description":"Okta Resource Name (ORN) of the authorization server"},"name":{"type":"string","description":"Name of the authorization server"},"issuerUrl":{"type":"string","description":"Issuer URL of the connected authorization server"},"scopeCondition":{"$ref":"#/components/schemas/authorization-server-scope-condition"},"scopes":{"type":"array","description":"Connected authorization server scopes that the AI agent has access to","items":{"type":"string"}}}}},"components/schemas/reviewer-ai-agent-connected-resource-app":{"id":"components/schemas/reviewer-ai-agent-connected-resource-app","kind":"json-schema","title":"reviewer-ai-agent-connected-resource-app","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"App details for an AI agent connection","properties":{"id":{"type":"string","description":"ID of the connected app"},"orn":{"type":"string","description":"Okta Resource Name (ORN) of the connected app"},"name":{"type":"string","description":"Name of the connected app"}}}},"components/schemas/reviewer-ai-agent-connected-resource-mcp-server":{"id":"components/schemas/reviewer-ai-agent-connected-resource-mcp-server","kind":"json-schema","title":"reviewer-ai-agent-connected-resource-mcp-server","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"MCP server details for an AI agent connection","properties":{"id":{"type":"string","description":"ID of the connected MCP server"},"orn":{"type":"string","description":"Okta Resource Name (ORN) of the connected MCP server"},"name":{"type":"string","description":"Name of the connected MCP server"},"endpointUrl":{"type":"string","description":"Connected MCP server access URL for the AI agent"}}}},"components/schemas/reviewer-ai-agent-connected-resource-api-server":{"id":"components/schemas/reviewer-ai-agent-connected-resource-api-server","kind":"json-schema","title":"reviewer-ai-agent-connected-resource-api-server","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"API server details for an AI agent connection","properties":{"id":{"type":"string","description":"ID of the connected API server"},"orn":{"type":"string","description":"Okta Resource Name (ORN) of the connected API server"},"name":{"type":"string","description":"Name of the connected API server"},"resourceUrl":{"type":"string","description":"URL of the connected API server"},"scopes":{"type":"array","description":"Connected API server scopes that the AI agent has access to","minItems":0,"maxItems":50,"items":{"type":"string","maxLength":1000}}}}},"components/schemas/reviewer-ai-agent-connected-resource-service-account-app":{"id":"components/schemas/reviewer-ai-agent-connected-resource-service-account-app","kind":"json-schema","title":"reviewer-ai-agent-connected-resource-service-account-app","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"App details of the connected service account","properties":{"orn":{"type":"string","description":"Okta Resource Name (ORN) of the app"},"name":{"type":"string","description":"Name of the app"}}}},"components/schemas/reviewer-ai-agent-connected-resource-service-account":{"id":"components/schemas/reviewer-ai-agent-connected-resource-service-account","kind":"json-schema","title":"reviewer-ai-agent-connected-resource-service-account","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Service account details for an AI agent connection","properties":{"orn":{"type":"string","description":"Okta Resource Name (ORN) of the connected service account"},"name":{"type":"string","description":"Name of the connected service account"},"app":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource-service-account-app"}}}},"components/schemas/reviewer-ai-agent-connected-resource-secret":{"id":"components/schemas/reviewer-ai-agent-connected-resource-secret","kind":"json-schema","title":"reviewer-ai-agent-connected-resource-secret","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"OPA secret details for an AI agent connection","properties":{"orn":{"type":"string","description":"Okta Resource Name (ORN) of the connected OPA secret"},"name":{"type":"string","description":"Name of the connected OPA secret"},"description":{"type":"string","description":"Description of the connected OPA secret"},"path":{"type":"string","description":"Path of the connected OPA secret"}}}},"components/schemas/ai-agent-connected-resource-type":{"id":"components/schemas/ai-agent-connected-resource-type","kind":"json-schema","title":"ai-agent-connected-resource-type","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Type of resource connected to an AI agent","enum":["APP","MCP_SERVER","API_SERVER","AUTHORIZATION_SERVER","OPA_SECRET","APP_SERVICE_ACCOUNT"]}},"components/schemas/reviewer-ai-agent-connected-resource":{"id":"components/schemas/reviewer-ai-agent-connected-resource","kind":"json-schema","title":"reviewer-ai-agent-connected-resource","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"AI agent connection resource details","required":["type"],"properties":{"authorizationServer":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource-authorization-server"},"app":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource-app"},"mcpServer":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource-mcp-server"},"apiServer":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource-api-server"},"serviceAccount":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource-service-account"},"opaSecret":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource-secret"},"type":{"$ref":"#/components/schemas/ai-agent-connected-resource-type"}}}},"components/schemas/reviewer-ai-agent-connection":{"id":"components/schemas/reviewer-ai-agent-connection","kind":"json-schema","title":"reviewer-ai-agent-connection","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"AI agent connection","required":["id"],"properties":{"id":{"type":"string","description":"AI agent connection ID","minLength":1,"maxLength":20},"name":{"type":"string","description":"Name of the resource associated with this connection","minLength":1,"maxLength":255},"connectedResource":{"$ref":"#/components/schemas/reviewer-ai-agent-connected-resource"}}}},"components/schemas/review-minimal-read-only-fields":{"id":"components/schemas/review-minimal-read-only-fields","kind":"json-schema","title":"review-minimal-read-only-fields","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Properties contained by default in sparse representation.\n","required":["campaignId","resourceId","decision","remediationStatus","principalProfile","reviewerType","_links"],"properties":{"campaignId":{"type":"string","minLength":1,"maxLength":20},"resourceId":{"type":"string","minLength":1,"maxLength":36},"entitlementValue":{"$ref":"#/components/schemas/reviewer-entitlement-value"},"entitlementBundle":{"$ref":"#/components/schemas/reviewer-entitlement-bundle"},"decision":{"$ref":"#/components/schemas/decision"},"decided":{"type":"string","format":"date-time"},"remediationStatus":{"$ref":"#/components/schemas/remediation-status"},"principalProfile":{"$ref":"#/components/schemas/principal-profile-enriched"},"reviewerProfile":{"$ref":"#/components/schemas/principal-profile-enriched"},"reviewerType":{"$ref":"#/components/schemas/reviewers-reviewer-type"},"reviewerGroupProfile":{"$ref":"#/components/schemas/reviewer-group-profile"},"currentReviewerLevel":{"description":"The current reviewer level of each review. Applicable only for multi level campaigns only.","$ref":"#/components/schemas/reviewer-level-type"},"_links":{"$ref":"#/components/schemas/review-links"},"riskRuleConflicts":{"type":"array","description":"List of risk rule conflicts caused by this entitlement value. Only applies to review item that has entitlement value.","nullable":true,"items":{"$ref":"#/components/schemas/risk-rule-conflicts"}},"delegatorProfile":{"description":"Specifies delegator profile if this review was delegated by original reviewer due to their governence delegate settings","$ref":"#/components/schemas/principal-profile-enriched"},"delegated":{"description":"Specifies if this review was delegated by the original reviewer based on their governance delegate settings","type":"boolean"},"appServiceAccount":{"$ref":"#/components/schemas/reviewer-service-account"},"oktaServiceAccount":{"$ref":"#/components/schemas/reviewer-service-account"},"aiAgentConnection":{"$ref":"#/components/schemas/reviewer-ai-agent-connection"}}}},"components/schemas/review-sparse":{"id":"components/schemas/review-sparse","kind":"json-schema","title":"review-sparse","data":{"description":"Sparse representation of a Review resource","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"$ref":"#/components/schemas/review-minimal-read-only-fields"}]}},"components/schemas/review-list-links":{"id":"components/schemas/review-list-links","kind":"json-schema","title":"review-list-links","data":{"type":"object","description":"Links available in review list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/review-list":{"id":"components/schemas/review-list","kind":"json-schema","title":"review-list","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["data","_links"],"properties":{"data":{"description":"Sparse representation of reviews\n","type":"array","items":{"$ref":"#/components/schemas/review-sparse"}},"_links":{"$ref":"#/components/schemas/review-list-links"}}}},"components/schemas/reviews-reassign":{"id":"components/schemas/reviews-reassign","kind":"json-schema","title":"reviews-reassign","data":{"required":["reviewerId","reviewIds","note"],"properties":{"reviewerId":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta user "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the new reviewer"},"children":[]}]}]}],"minLength":1},"reviewIds":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A list of reviews (review "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" values) that are reassigned to the new reviewer."},"children":[]}]}]}],"items":{"type":"string"},"minItems":1,"maxItems":50},"reviewerLevel":{"description":"Applicable only for multi level campaigns. The reviewer level at which the reviews should be reassigned.","$ref":"#/components/schemas/reviewer-level-type"},"note":{"type":"string","description":"A note to justify the reassignment decision for the specified review(s).","minLength":1,"maxLength":300}}}},"components/schemas/review-reassign-list-links":{"id":"components/schemas/review-reassign-list-links","kind":"json-schema","title":"review-reassign-list-links","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Links available in after reassigning reviews","required":["self","reviews"],"properties":{"self":{"$ref":"#/components/schemas/link"},"reviews":{"$ref":"#/components/schemas/link"}}}},"components/schemas/review-reassign-list":{"id":"components/schemas/review-reassign-list","kind":"json-schema","title":"review-reassign-list","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["data","_links"],"properties":{"data":{"description":"All the reviews that were reassigned\n","type":"array","items":{"$ref":"#/components/schemas/review-sparse"}},"_links":{"allOf":[{"$ref":"#/components/schemas/review-reassign-list-links"}]}}}},"components/schemas/note":{"id":"components/schemas/note","kind":"json-schema","title":"note","data":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":20},"note":{"type":"string","minLength":1,"maxLength":300}}}},"components/schemas/reviewer-level-info-full":{"id":"components/schemas/reviewer-level-info-full","kind":"json-schema","title":"reviewer-level-info-full","data":{"description":"Full representation of a reviewer level. Applicable for multi level campaigns only.","required":["reviewerLevel","decision","reviewerType","id","createdBy","created","lastUpdated","lastUpdatedBy"],"x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"}],"properties":{"reviewerLevel":{"description":"The reviewer level.","$ref":"#/components/schemas/reviewer-level-type"},"decision":{"description":"The decision made at that reviewer level.","$ref":"#/components/schemas/decision"},"reviewerProfile":{"description":"The reviewer (user) who made the decision at that reviewer level","$ref":"#/components/schemas/principal-profile-enriched"},"reviewerType":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the type of the reviewers at that reviewer level. Reviewers can be "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"USER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RESOURCE_OWNER"},"children":[]}]}]}],"$ref":"#/components/schemas/reviewers-reviewer-type"},"reviewerGroupProfile":{"$ref":"#/components/schemas/reviewer-group-profile"}}}},"components/schemas/review-read-only-fields":{"id":"components/schemas/review-read-only-fields","kind":"json-schema","title":"review-read-only-fields","data":{"description":"Additional read-only attributes for reviews","properties":{"note":{"$ref":"#/components/schemas/note"},"reviewerGroupProfile":{"$ref":"#/components/schemas/reviewer-group-profile"},"allReviewerLevels":{"description":"Applicable only for multi level campaign. Provides details about the reviewer and decisions (if any) made at each reviewer level is captured here.","type":"array","items":{"$ref":"#/components/schemas/reviewer-level-info-full"},"minItems":1,"maxItems":2}}}},"components/schemas/review-full":{"id":"components/schemas/review-full","kind":"json-schema","title":"review-full","data":{"description":"Full representation of a Review resource","allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"$ref":"#/components/schemas/review-minimal-read-only-fields"},{"$ref":"#/components/schemas/review-read-only-fields"}]}},"components/schemas/scim-filter":{"id":"components/schemas/scim-filter","kind":"json-schema","title":"scim-filter","data":{"type":"string","format":"scim-filter"}},"components/schemas/entitlement-bundle-id":{"id":"components/schemas/entitlement-bundle-id","kind":"json-schema","title":"entitlement-bundle-id","data":{"type":"string","maxLength":20,"minLength":20,"format":"entitlement-bundle-id","pattern":"enb[0-9a-zA-Z]+","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entitlement bundle "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}]}},"components/schemas/order-by":{"id":"components/schemas/order-by","kind":"json-schema","title":"order-by","data":{"type":"string","format":"order-by","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A property of items within the collection, optionally followed by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"%20desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"children":[]}]}]}]}},"components/schemas/bundle-writable-standard-properties":{"id":"components/schemas/bundle-writable-standard-properties","kind":"json-schema","title":"bundle-writable-standard-properties","data":{"type":"object","properties":{"name":{"type":"string","nullable":false,"description":"The unique name of the entitlement bundle","maxLength":255,"minLength":1},"description":{"type":"string","nullable":false,"description":"The human-readable description","maxLength":1000,"minLength":1}},"example":{"name":"my-object-1","description":"The unique instance of my-object-1"}}},"components/schemas/okta-bundle-orn":{"id":"components/schemas/okta-bundle-orn","kind":"json-schema","title":"okta-bundle-orn","data":{"type":"string","format":"okta-resource-orn","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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the bundle in "},"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 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/resource-orn":{"id":"components/schemas/resource-orn","kind":"json-schema","title":"resource-orn","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-resource-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta resource in "},"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 format"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the ORN format for "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#supported-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/resource-id":{"id":"components/schemas/resource-id","kind":"json-schema","title":"resource-id","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-resource-id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"app.id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the resource."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"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/openapi/okta-management/management/application/listapplications"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"List applications"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to retrieve app IDs."},"children":[]}]}]}],"maxLength":20}},"components/schemas/resource-type-2":{"id":"components/schemas/resource-type-2","kind":"json-schema","title":"resource-type-2","data":{"type":"string","description":"The type of resource","enum":["APPLICATION"]}},"components/schemas/target-resource":{"id":"components/schemas/target-resource","kind":"json-schema","title":"target-resource","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Representation of a resource","required":["externalId","type"],"properties":{"externalId":{"$ref":"#/components/schemas/resource-id"},"type":{"$ref":"#/components/schemas/resource-type-2"}}}},"components/schemas/entitlement-bundle-status":{"id":"components/schemas/entitlement-bundle-status","kind":"json-schema","title":"entitlement-bundle-status","data":{"type":"string","enum":["ACTIVE","DELETED"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The lifecycle status of an entitlement bundle:"},"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":"An entitlement bundle has a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ACTIVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" after creation."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When the bundle is deleted, it transitions to a status of "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETED"},"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 the entitlement bundle is purged, it isn't returned in a GET operation."},"children":[]}]}]}]}},"components/schemas/entitlement-property-id":{"id":"components/schemas/entitlement-property-id","kind":"json-schema","title":"entitlement-property-id","data":{"type":"string","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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property of an entitlement"},"children":[]}]}]}],"minLength":20,"maxLength":20}},"components/schemas/entitlement-property-display-name":{"id":"components/schemas/entitlement-property-display-name","kind":"json-schema","title":"entitlement-property-display-name","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The display name for an entitlement property","minLength":1,"maxLength":255}},"components/schemas/entitlement-property-value":{"id":"components/schemas/entitlement-property-value","kind":"json-schema","title":"entitlement-property-value","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The value of an entitlement property","minLength":1,"maxLength":255}},"components/schemas/entitlement-property-description":{"id":"components/schemas/entitlement-property-description","kind":"json-schema","title":"entitlement-property-description","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The description of an entitlement property","minLength":1,"maxLength":1000}},"components/schemas/entitlement-property-multi-value":{"id":"components/schemas/entitlement-property-multi-value","kind":"json-schema","title":"entitlement-property-multi-value","data":{"type":"boolean","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":"Indicates if the entitlement property can hold multiple values. If this property is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", then the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"dataType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"array"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/entitlement-property-required":{"id":"components/schemas/entitlement-property-required","kind":"json-schema","title":"entitlement-property-required","data":{"type":"boolean","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The property that determines if the entitlement property is a required attribute"}},"components/schemas/entitlement-property-datatype":{"id":"components/schemas/entitlement-property-datatype","kind":"json-schema","title":"entitlement-property-datatype","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The data type of the entitlement property","enum":["string","array"],"x-enumDescriptions":{"string":"The entitlement property is a single value.","array":"The entitlement property is multivalued."}}},"components/schemas/entitlement-property-full":{"id":"components/schemas/entitlement-property-full","kind":"json-schema","title":"entitlement-property-full","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Attributes related to an entitlement","properties":{"id":{"$ref":"#/components/schemas/entitlement-property-id"},"name":{"$ref":"#/components/schemas/entitlement-property-display-name"},"externalValue":{"$ref":"#/components/schemas/entitlement-property-value"},"description":{"$ref":"#/components/schemas/entitlement-property-description"},"multiValue":{"$ref":"#/components/schemas/entitlement-property-multi-value"},"required":{"$ref":"#/components/schemas/entitlement-property-required"},"dataType":{"$ref":"#/components/schemas/entitlement-property-datatype"}}}},"components/schemas/entitlement-value-id":{"id":"components/schemas/entitlement-value-id","kind":"json-schema","title":"entitlement-value-id","data":{"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the entitlement value"},"children":[]}]}]}],"minLength":20,"maxLength":20}},"components/schemas/entitlement-value-display-name":{"id":"components/schemas/entitlement-value-display-name","kind":"json-schema","title":"entitlement-value-display-name","data":{"type":"string","description":"The display name for an entitlement value","minLength":1,"maxLength":255}},"components/schemas/entitlement-value-external":{"id":"components/schemas/entitlement-value-external","kind":"json-schema","title":"entitlement-value-external","data":{"type":"string","description":"The value of an entitlement property value","minLength":1,"maxLength":2000}},"components/schemas/entitlement-value-external-id":{"id":"components/schemas/entitlement-value-external-id","kind":"json-schema","title":"entitlement-value-external-id","data":{"type":"string","description":"The read-only ID of an entitlement property value in the downstream app","minLength":1,"maxLength":512}},"components/schemas/entitlement-value-description":{"id":"components/schemas/entitlement-value-description","kind":"json-schema","title":"entitlement-value-description","data":{"type":"string","description":"The description of an entitlement value","minLength":1,"maxLength":1024}},"components/schemas/okta-entitlement-value-orn":{"id":"components/schemas/okta-entitlement-value-orn","kind":"json-schema","title":"okta-entitlement-value-orn","data":{"type":"string","format":"okta-resource-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entitlement value resource, in "},"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 format"},"children":[]}]}]}]}]}},"components/schemas/entitlement-value-full":{"id":"components/schemas/entitlement-value-full","kind":"json-schema","title":"entitlement-value-full","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Attributes related to an entitlement value","properties":{"id":{"$ref":"#/components/schemas/entitlement-value-id"},"name":{"$ref":"#/components/schemas/entitlement-value-display-name"},"externalValue":{"$ref":"#/components/schemas/entitlement-value-external"},"externalId":{"$ref":"#/components/schemas/entitlement-value-external-id"},"description":{"$ref":"#/components/schemas/entitlement-value-description"},"orn":{"$ref":"#/components/schemas/okta-entitlement-value-orn"},"createdBy":{"$ref":"#/components/schemas/created-by"},"created":{"$ref":"#/components/schemas/created"},"lastUpdated":{"$ref":"#/components/schemas/last-updated"},"lastUpdatedBy":{"$ref":"#/components/schemas/last-updated-by"}}}},"components/schemas/entitlement-values-full":{"id":"components/schemas/entitlement-values-full","kind":"json-schema","title":"entitlement-values-full","data":{"type":"array","description":"Collection of entitlement values","items":{"$ref":"#/components/schemas/entitlement-value-full"}}},"components/schemas/entitlement-full":{"id":"components/schemas/entitlement-full","kind":"json-schema","title":"entitlement-full","data":{"type":"object","description":"Representation of all entitlements and their values","allOf":[{"$ref":"#/components/schemas/entitlement-property-full"}],"x-okta-ignore-redocly-rules-for-sdk":true,"required":["id"],"properties":{"values":{"$ref":"#/components/schemas/entitlement-values-full"}}}},"components/schemas/entitlements-full":{"id":"components/schemas/entitlements-full","kind":"json-schema","title":"entitlements-full","data":{"type":"array","description":"Collection of entitlements with associated values","nullable":false,"items":{"$ref":"#/components/schemas/entitlement-full"}}},"components/schemas/entitlement-bundle-links":{"id":"components/schemas/entitlement-bundle-links","kind":"json-schema","title":"entitlement-bundle-links","data":{"type":"object","description":"Links available on a single entitlement bundle representation","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/entitlement-bundle-full-with-entitlements":{"id":"components/schemas/entitlement-bundle-full-with-entitlements","kind":"json-schema","title":"entitlement-bundle-full-with-entitlements","data":{"description":"Full representation of a entitlement bundle resource","allOf":[{"$ref":"#/components/schemas/bundle-writable-standard-properties"},{"$ref":"#/components/schemas/read-only-standard-properties"}],"required":["id","name","orn","created","createdBy","lastUpdated","lastUpdatedBy","status","targetResourceOrn","target","_links"],"properties":{"orn":{"$ref":"#/components/schemas/okta-bundle-orn"},"targetResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"target":{"$ref":"#/components/schemas/target-resource"},"status":{"$ref":"#/components/schemas/entitlement-bundle-status"},"entitlements":{"$ref":"#/components/schemas/entitlements-full"},"_links":{"$ref":"#/components/schemas/entitlement-bundle-links"}}}},"components/schemas/entitlement-bundle-list-links":{"id":"components/schemas/entitlement-bundle-list-links","kind":"json-schema","title":"entitlement-bundle-list-links","data":{"type":"object","description":"Links available in entitlement bundle list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/list-metadata":{"id":"components/schemas/list-metadata","kind":"json-schema","title":"list-metadata","data":{"type":"object","description":"Metadata for the list response","properties":{"total":{"type":"integer","description":"Total number of objects","minimum":0,"example":50}}}},"components/schemas/entitlement-bundles-list-with-entitlements":{"id":"components/schemas/entitlement-bundles-list-with-entitlements","kind":"json-schema","title":"entitlement-bundles-list-with-entitlements","data":{"type":"object","properties":{"data":{"description":"All entitlement bundles on the current page","type":"array","items":{"$ref":"#/components/schemas/entitlement-bundle-full-with-entitlements"}},"_links":{"$ref":"#/components/schemas/entitlement-bundle-list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/entitlement-value-creatable":{"id":"components/schemas/entitlement-value-creatable","kind":"json-schema","title":"entitlement-value-creatable","data":{"type":"object","description":"Entitlement value ID","properties":{"id":{"$ref":"#/components/schemas/entitlement-value-id"}}}},"components/schemas/entitlement-values-creatable":{"id":"components/schemas/entitlement-values-creatable","kind":"json-schema","title":"entitlement-values-creatable","data":{"type":"array","description":"Collection of entitlement value identifiers","nullable":false,"minLength":1,"maxLength":1000,"items":{"$ref":"#/components/schemas/entitlement-value-creatable"}}},"components/schemas/entitlement-creatable":{"id":"components/schemas/entitlement-creatable","kind":"json-schema","title":"entitlement-creatable","data":{"type":"object","description":"An entitlement with associated value identifiers","properties":{"id":{"$ref":"#/components/schemas/entitlement-property-id"},"values":{"$ref":"#/components/schemas/entitlement-values-creatable"}}}},"components/schemas/entitlements-creatable":{"id":"components/schemas/entitlements-creatable","kind":"json-schema","title":"entitlements-creatable","data":{"type":"array","description":"Collection of entitlements and associated value identifiers","nullable":false,"items":{"$ref":"#/components/schemas/entitlement-creatable"}}},"components/schemas/entitlement-bundle-creatable":{"id":"components/schemas/entitlement-bundle-creatable","kind":"json-schema","title":"entitlement-bundle-creatable","data":{"description":"The properties expected in an initial add entitlement bundle","x-okta-ignore-redocly-rules-for-sdk":true,"required":["name","target","entitlements"],"allOf":[{"$ref":"#/components/schemas/bundle-writable-standard-properties"}],"properties":{"target":{"$ref":"#/components/schemas/target-resource"},"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"}}}},"components/schemas/entitlement-bundle-full":{"id":"components/schemas/entitlement-bundle-full","kind":"json-schema","title":"entitlement-bundle-full","data":{"description":"Full representation of a entitlement bundle resource","allOf":[{"$ref":"#/components/schemas/bundle-writable-standard-properties"},{"$ref":"#/components/schemas/read-only-standard-properties"}],"required":["id","name","orn","created","createdBy","lastUpdated","lastUpdatedBy","status","targetResourceOrn","target","_links"],"properties":{"orn":{"$ref":"#/components/schemas/okta-bundle-orn"},"targetResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"target":{"$ref":"#/components/schemas/target-resource"},"status":{"$ref":"#/components/schemas/entitlement-bundle-status"},"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"},"_links":{"$ref":"#/components/schemas/entitlement-bundle-links"}}}},"components/schemas/entitlement-bundle-updatable":{"id":"components/schemas/entitlement-bundle-updatable","kind":"json-schema","title":"entitlement-bundle-updatable","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/bundle-writable-standard-properties"}],"x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","name","targetResourceOrn","target"],"properties":{"id":{"description":"Unique identifier for the object","type":"string","minLength":1},"targetResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"target":{"$ref":"#/components/schemas/target-resource"},"status":{"$ref":"#/components/schemas/entitlement-bundle-status"},"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"}}}},"components/schemas/resource-asset-name":{"id":"components/schemas/resource-asset-name","kind":"json-schema","title":"resource-asset-name","data":{"type":"string","description":"The display name for a resource asset","minLength":1,"maxLength":255}},"components/schemas/resource-asset-description":{"id":"components/schemas/resource-asset-description","kind":"json-schema","title":"resource-asset-description","data":{"type":"string","description":"The description of a resource asset","minLength":1,"maxLength":255}},"components/schemas/resource-asset-type-sparse":{"id":"components/schemas/resource-asset-type-sparse","kind":"json-schema","title":"resource-asset-type-sparse","data":{"type":"object","description":"The type of the resource asset","properties":{"id":{"type":"string","description":"The unique identifier for the resource asset type","minLength":20,"maxLength":20},"displayName":{"type":"string","description":"The display name of the resource asset type","minLength":1,"maxLength":255}},"required":["id","displayName"]}},"components/schemas/resource-asset-external-id":{"id":"components/schemas/resource-asset-external-id","kind":"json-schema","title":"resource-asset-external-id","data":{"type":"string","description":"The external ID of a resource asset","minLength":1,"maxLength":512}},"components/schemas/resource-asset-links":{"id":"components/schemas/resource-asset-links","kind":"json-schema","title":"resource-asset-links","data":{"type":"object","description":"Links available in resource asset response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/resource-asset":{"id":"components/schemas/resource-asset","kind":"json-schema","title":"resource-asset","data":{"description":"Representation of a resource asset.","allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"type":"object","properties":{"orn":{"$ref":"#/components/schemas/resource-orn"},"name":{"$ref":"#/components/schemas/resource-asset-name"},"description":{"$ref":"#/components/schemas/resource-asset-description"},"type":{"$ref":"#/components/schemas/resource-asset-type-sparse"},"externalId":{"$ref":"#/components/schemas/resource-asset-external-id"},"_links":{"$ref":"#/components/schemas/resource-asset-links"}},"required":["orn","name","type","externalId"]}]}},"components/schemas/resource-asset-with-hierarchy-context":{"id":"components/schemas/resource-asset-with-hierarchy-context","kind":"json-schema","title":"resource-asset-with-hierarchy-context","data":{"description":"Representation of a resource asset with context about its hierarchy.","allOf":[{"$ref":"#/components/schemas/resource-asset"},{"type":"object","properties":{"hasChildren":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether this asset has any children in the hierarchy. Present only if ?include=children_info is specified"},"children":[]}]}]}]},"parentId":{"type":"string","nullable":true,"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 direct parent asset, or null if this is a root asset. Present only if ?include=ancestors is specified"},"children":[]}]}]}]}}}]}},"components/schemas/resource-asset-ancestor":{"id":"components/schemas/resource-asset-ancestor","kind":"json-schema","title":"resource-asset-ancestor","data":{"description":"An ancestor asset in the hierarchy, including its own parentId for chain traversal.","type":"object","properties":{"id":{"description":"Unique identifier for the asset","type":"string","minLength":1},"orn":{"$ref":"#/components/schemas/resource-orn"},"name":{"$ref":"#/components/schemas/resource-asset-name"},"type":{"$ref":"#/components/schemas/resource-asset-type-sparse"},"parentId":{"type":"string","nullable":true,"description":"The ID of this ancestor's direct parent, or null if it is a root asset"},"_links":{"$ref":"#/components/schemas/resource-asset-links"}},"required":["id","orn","name","type"]}},"components/schemas/resource-assets-links":{"id":"components/schemas/resource-assets-links","kind":"json-schema","title":"resource-assets-links","data":{"type":"object","description":"Links available in resource asset response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"},"parent":{"$ref":"#/components/schemas/link"},"children":{"$ref":"#/components/schemas/link"}}}},"components/schemas/resource-assets-list":{"id":"components/schemas/resource-assets-list","kind":"json-schema","title":"resource-assets-list","data":{"type":"object","required":["data","_links"],"properties":{"data":{"description":"List of all resource assets matching the filter","type":"array","items":{"$ref":"#/components/schemas/resource-asset-with-hierarchy-context"},"minItems":0},"ancestors":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A map of all unique ancestor assets for items in "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", keyed by asset ID. Only present if ?include=ancestors is specified. Each ancestor also includes its own "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"parentId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to allow full chain traversal to the root."},"children":[]}]}]}],"type":"object","additionalProperties":{"$ref":"#/components/schemas/resource-asset-ancestor"}},"_links":{"$ref":"#/components/schemas/resource-assets-links"}}}},"components/schemas/resource-asset-updatable":{"id":"components/schemas/resource-asset-updatable","kind":"json-schema","title":"resource-asset-updatable","data":{"description":"The updatable properties of a resource asset.","type":"object","properties":{"description":{"nullable":true,"x-explicit-null":true,"type":"string","description":"The description of a resource asset","minLength":1,"maxLength":255}}}},"components/schemas/resource-asset-type-display-name":{"id":"components/schemas/resource-asset-type-display-name","kind":"json-schema","title":"resource-asset-type-display-name","data":{"type":"string","description":"The display name for the resource asset type","minLength":1,"maxLength":255}},"components/schemas/resource-asset-type-links":{"id":"components/schemas/resource-asset-type-links","kind":"json-schema","title":"resource-asset-type-links","data":{"type":"object","description":"Links available in a resource asset type response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/resource-asset-type":{"id":"components/schemas/resource-asset-type","kind":"json-schema","title":"resource-asset-type","data":{"description":"Representation of a resource asset type","allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"type":"object","properties":{"displayName":{"$ref":"#/components/schemas/resource-asset-type-display-name"},"_links":{"$ref":"#/components/schemas/resource-asset-type-links"}},"required":["displayName"]}]}},"components/schemas/list-links":{"id":"components/schemas/list-links","kind":"json-schema","title":"list-links","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link relations 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":[]}]}]}]}],"required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/resource-asset-types-list":{"id":"components/schemas/resource-asset-types-list","kind":"json-schema","title":"resource-asset-types-list","data":{"type":"object","required":["data","_links"],"properties":{"data":{"description":"List of resource asset types for the resource","type":"array","items":{"$ref":"#/components/schemas/resource-asset-type"},"minItems":0},"_links":{"$ref":"#/components/schemas/list-links"}}}},"components/schemas/id":{"id":"components/schemas/id","kind":"json-schema","title":"id","data":{"description":"Unique identifier for the object","type":"string","minLength":1}},"components/schemas/grant-type":{"id":"components/schemas/grant-type","kind":"json-schema","title":"grant-type","data":{"type":"string","enum":["CUSTOM","ENTITLEMENT-BUNDLE","POLICY","ENTITLEMENT","IMPORT"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Type of grant. Reconciliation creates an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant to record an entitlement that the app reported, but that Okta wasn't already governing."},"children":[]}]}]}]}},"components/schemas/user-orn":{"id":"components/schemas/user-orn","kind":"json-schema","title":"user-orn","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-user-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta user in "},"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":" format"},"children":[]}]}]}],"example":"orn:okta:directory:00o8rk36Bp5eZKOrw0g4:users:00u1ktfFMZ5HNoj7k0g4"}},"components/schemas/user-id":{"id":"components/schemas/user-id","kind":"json-schema","title":"user-id","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-user-id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta user "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"maxLength":20,"minLength":20,"pattern":"00u[0-9a-zA-Z]+","example":"00ub0oNGTSWTBKOLGLNR"}},"components/schemas/principal-type":{"id":"components/schemas/principal-type","kind":"json-schema","title":"principal-type","data":{"type":"string","description":"The type of principal","enum":["OKTA_USER"]}},"components/schemas/target-principal-full":{"id":"components/schemas/target-principal-full","kind":"json-schema","title":"target-principal-full","data":{"type":"object","description":"Representation of a principal","required":["externalId","type"],"properties":{"externalId":{"$ref":"#/components/schemas/user-id"},"type":{"$ref":"#/components/schemas/principal-type"}}}},"components/schemas/grant-action":{"id":"components/schemas/grant-action","kind":"json-schema","title":"grant-action","data":{"type":"string","description":"The action to be taken for a grant","default":"ALLOW","enum":["ALLOW","DENY"]}},"components/schemas/grant-actor":{"id":"components/schemas/grant-actor","kind":"json-schema","title":"grant-actor","data":{"type":"string","description":"The flow that triggered the grant request","default":"API","enum":["API","ACCESS_REQUEST","NONE","ADMIN"],"x-enumDescriptions":{"API":"The grant request was triggered from the API.","ACCESS_REQUEST":"The grant request was triggered from an access request.","NONE":"The grant request wasn't triggered from the API, an access request, or the Admin Console.","ADMIN":"The grant request was triggered from the Admin Console."}}},"components/schemas/resource-grant-expiration-date":{"id":"components/schemas/resource-grant-expiration-date","kind":"json-schema","title":"resource-grant-expiration-date","data":{"type":"string","format":"date-time","description":"An optional expiration date. If provided, the entitlement bundle grant will be revoked at the specified date and time."}},"components/schemas/schedule-settings-writeable":{"id":"components/schemas/schedule-settings-writeable","kind":"json-schema","title":"schedule-settings-writeable","data":{"type":"object","description":"Scheduler specific settings applicable to a grant.","properties":{"expirationDate":{"$ref":"#/components/schemas/resource-grant-expiration-date"},"timeZone":{"type":"string","description":"The time zone, in IANA format, in which expirationDate was configured","minLength":1,"maxLength":64}}}},"components/schemas/entitlement-bundle-link":{"id":"components/schemas/entitlement-bundle-link","kind":"json-schema","title":"entitlement-bundle-link","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entitlement bundle details link. This link is only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"grantType"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENT-BUNDLE"},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/link"}],"x-okta-ignore-redocly-rules-for-sdk":true}},"components/schemas/resource-grant-links":{"id":"components/schemas/resource-grant-links","kind":"json-schema","title":"resource-grant-links","data":{"type":"object","description":"Links available on a single grant representation","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"entitlementBundle":{"$ref":"#/components/schemas/entitlement-bundle-link"}}}},"components/schemas/grant-status":{"id":"components/schemas/grant-status","kind":"json-schema","title":"grant-status","data":{"type":"string","enum":["ACTIVE","SCHEDULED","INACTIVE","EXPIRED"],"description":"The state of the particular grant setting"}},"components/schemas/collection-id":{"id":"components/schemas/collection-id","kind":"json-schema","title":"collection-id","data":{"type":"string","maxLength":20,"minLength":20,"format":"collection-id","pattern":"col[0-9a-zA-Z]+","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource collection "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}]}},"components/schemas/collection-metadata":{"id":"components/schemas/collection-metadata","kind":"json-schema","title":"collection-metadata","data":{"type":"object","description":"Collection metadata properties","properties":{"id":{"$ref":"#/components/schemas/collection-id"},"name":{"type":"string","nullable":false,"description":"The name of a resource collection","maxLength":255,"minLength":1}}}},"components/schemas/grant-metadata":{"id":"components/schemas/grant-metadata","kind":"json-schema","title":"grant-metadata","data":{"type":"object","description":"Grant metadata properties","properties":{"collection":{"$ref":"#/components/schemas/collection-metadata"}}}},"components/schemas/grant-full":{"id":"components/schemas/grant-full","kind":"json-schema","title":"Grant","data":{"type":"object","title":"Grant","description":"Grant response","allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"}],"x-okta-ignore-redocly-rules-for-sdk":true,"required":["grantType","id","created","createdBy","lastUpdated","lastUpdatedBy","action","actor","targetResourceOrn","target","targetPrincipalOrn","targetPrincipal","_links","status"],"properties":{"grantType":{"$ref":"#/components/schemas/grant-type"},"entitlementBundleId":{"$ref":"#/components/schemas/entitlement-bundle-id"},"targetPrincipalOrn":{"$ref":"#/components/schemas/user-orn"},"targetPrincipal":{"$ref":"#/components/schemas/target-principal-full"},"action":{"$ref":"#/components/schemas/grant-action"},"actor":{"$ref":"#/components/schemas/grant-actor"},"targetResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"target":{"$ref":"#/components/schemas/target-resource"},"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"},"scheduleSettings":{"$ref":"#/components/schemas/schedule-settings-writeable"},"_links":{"$ref":"#/components/schemas/resource-grant-links"},"status":{"$ref":"#/components/schemas/grant-status"},"metadata":{"$ref":"#/components/schemas/grant-metadata"}}}},"components/schemas/grant-list-links":{"id":"components/schemas/grant-list-links","kind":"json-schema","title":"grant-list-links","data":{"type":"object","description":"Links available in grants list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/grants-list":{"id":"components/schemas/grants-list","kind":"json-schema","title":"grants-list","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/grant-full"}},"_links":{"$ref":"#/components/schemas/grant-list-links"}}}},"components/schemas/grant-full-with-entitlements":{"id":"components/schemas/grant-full-with-entitlements","kind":"json-schema","title":"Grant with entitlements","data":{"type":"object","title":"Grant with entitlements","description":"Grant response with entitlements","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"}],"required":["grantType","id","created","createdBy","lastUpdated","lastUpdatedBy","action","actor","targetResourceOrn","target","targetPrincipalOrn","targetPrincipal","entitlements","_links","status"],"properties":{"grantType":{"$ref":"#/components/schemas/grant-type"},"entitlementBundleId":{"$ref":"#/components/schemas/entitlement-bundle-id"},"targetPrincipalOrn":{"$ref":"#/components/schemas/user-orn"},"targetPrincipal":{"$ref":"#/components/schemas/target-principal-full"},"action":{"$ref":"#/components/schemas/grant-action"},"actor":{"$ref":"#/components/schemas/grant-actor"},"targetResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"target":{"$ref":"#/components/schemas/target-resource"},"entitlements":{"$ref":"#/components/schemas/entitlements-full"},"scheduleSettings":{"$ref":"#/components/schemas/schedule-settings-writeable"},"_links":{"$ref":"#/components/schemas/resource-grant-links"},"status":{"$ref":"#/components/schemas/grant-status"},"metadata":{"$ref":"#/components/schemas/grant-metadata"}}}},"components/schemas/grants-list-with-entitlements":{"id":"components/schemas/grants-list-with-entitlements","kind":"json-schema","title":"grants-list-with-entitlements","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/grant-full-with-entitlements"}},"_links":{"$ref":"#/components/schemas/grant-list-links"}}}},"components/schemas/target-principal":{"id":"components/schemas/target-principal","kind":"json-schema","title":"target-principal","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"A representation of a principal","required":["externalId","type"],"properties":{"externalId":{"$ref":"#/components/schemas/user-id"},"type":{"$ref":"#/components/schemas/principal-type"}}}},"components/schemas/standard-grant-properties-writeable":{"id":"components/schemas/standard-grant-properties-writeable","kind":"json-schema","title":"standard-grant-properties-writeable","data":{"type":"object","required":["targetPrincipal"],"properties":{"targetPrincipal":{"$ref":"#/components/schemas/target-principal"},"scheduleSettings":{"$ref":"#/components/schemas/schedule-settings-writeable"},"action":{"$ref":"#/components/schemas/grant-action"},"actor":{"$ref":"#/components/schemas/grant-actor"}}}},"components/schemas/grant-type-bundle-writeable":{"id":"components/schemas/grant-type-bundle-writeable","kind":"json-schema","title":"grant-type-bundle-writeable","data":{"type":"object","description":"entitlement bundle as the grant source","allOf":[{"$ref":"#/components/schemas/standard-grant-properties-writeable"}],"x-okta-ignore-redocly-rules-for-sdk":true,"required":["grantType","entitlementBundleId"],"properties":{"grantType":{"description":"Additive grant type for entitlement bundle.","type":"string","enum":["ENTITLEMENT-BUNDLE"]},"entitlementBundleId":{"$ref":"#/components/schemas/entitlement-bundle-id"}}}},"components/schemas/grant-type-custom-writeable":{"id":"components/schemas/grant-type-custom-writeable","kind":"json-schema","title":"grant-type-custom-writeable","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Custom resource source object","allOf":[{"$ref":"#/components/schemas/standard-grant-properties-writeable"}],"required":["grantType","target"],"properties":{"grantType":{"type":"string","description":"Base grant type for assigning specific entitlement and respective value(s).","enum":["CUSTOM"]},"target":{"$ref":"#/components/schemas/target-resource"},"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"}}}},"components/schemas/grant-type-policy-writeable":{"id":"components/schemas/grant-type-policy-writeable","kind":"json-schema","title":"grant-type-policy-writeable","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Configured policy as the source for grant request","allOf":[{"$ref":"#/components/schemas/standard-grant-properties-writeable"}],"required":["grantType","target"],"properties":{"grantType":{"type":"string","description":"Base grant type for assigning entitlements driven by policy","enum":["POLICY"]},"target":{"$ref":"#/components/schemas/target-resource"}}}},"components/schemas/grant-type-entitlement-writeable":{"id":"components/schemas/grant-type-entitlement-writeable","kind":"json-schema","title":"grant-type-entitlement-writeable","data":{"type":"object","description":"entitlements as the grant source","required":["grantType","target","entitlements","targetPrincipal"],"properties":{"grantType":{"type":"string","description":"Additive grant type for assigning specific entitlement and respective value(s).","enum":["ENTITLEMENT"]},"target":{"$ref":"#/components/schemas/target-resource"},"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"},"targetPrincipal":{"$ref":"#/components/schemas/target-principal"},"scheduleSettings":{"$ref":"#/components/schemas/schedule-settings-writeable"},"action":{"$ref":"#/components/schemas/grant-action"},"actor":{"$ref":"#/components/schemas/grant-actor"}}}},"components/schemas/grant-creatable":{"id":"components/schemas/grant-creatable","kind":"json-schema","title":"grant-creatable","data":{"description":"The properties expected in an initial add entitlement bundle","default":{"grantType":"ENTITLEMENT-BUNDLE"},"oneOf":[{"$ref":"#/components/schemas/grant-type-bundle-writeable"},{"$ref":"#/components/schemas/grant-type-custom-writeable"},{"$ref":"#/components/schemas/grant-type-policy-writeable"},{"$ref":"#/components/schemas/grant-type-entitlement-writeable"}],"discriminator":{"propertyName":"grantType","mapping":{"ENTITLEMENT-BUNDLE":"#/components/schemas/grant-type-bundle-writeable","CUSTOM":"#/components/schemas/grant-type-custom-writeable","POLICY":"#/components/schemas/grant-type-policy-writeable","ENTITLEMENT":"#/components/schemas/grant-type-entitlement-writeable"}}}},"components/schemas/grant-patch":{"id":"components/schemas/grant-patch","kind":"json-schema","title":"grant-patch","data":{"type":"object","required":["id","scheduleSettings"],"properties":{"id":{"description":"Unique identifier for the object","type":"string","minLength":1},"scheduleSettings":{"$ref":"#/components/schemas/schedule-settings-writeable"}}}},"components/schemas/entitlement-links":{"id":"components/schemas/entitlement-links","kind":"json-schema","title":"entitlement-links","data":{"type":"object","description":"Links available in list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"values":{"$ref":"#/components/schemas/link"}}}},"components/schemas/entitlements-list-object":{"id":"components/schemas/entitlements-list-object","kind":"json-schema","title":"entitlements-list-object","data":{"type":"object","description":"Representation of an entitlement object.","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/entitlement-property-full"},{"$ref":"#/components/schemas/read-only-standard-properties"}],"properties":{"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"parent":{"$ref":"#/components/schemas/target-resource"},"_links":{"$ref":"#/components/schemas/entitlement-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}},"required":["id","name","externalValue","multiValue","dataType","parent","parentResourceOrn","created","createdBy","lastUpdated","lastUpdatedBy"]}},"components/schemas/entitlements-list":{"id":"components/schemas/entitlements-list","kind":"json-schema","title":"entitlements-list","data":{"type":"object","required":["data","_links","metadata"],"properties":{"data":{"description":"List of all entitlements matching the filter","type":"array","items":{"$ref":"#/components/schemas/entitlements-list-object"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/entitlement-writable-properties":{"id":"components/schemas/entitlement-writable-properties","kind":"json-schema","title":"entitlement-writable-properties","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["name","externalValue","parent","multiValue","dataType","values"],"properties":{"name":{"$ref":"#/components/schemas/entitlement-property-display-name"},"externalValue":{"$ref":"#/components/schemas/entitlement-property-value"},"description":{"$ref":"#/components/schemas/entitlement-property-description"},"multiValue":{"$ref":"#/components/schemas/entitlement-property-multi-value"},"dataType":{"$ref":"#/components/schemas/entitlement-property-datatype"}},"example":{"name":"my-object-1","description":"The unique instance of my-object-1"}}},"components/schemas/entitlement-value-writable-properties":{"id":"components/schemas/entitlement-value-writable-properties","kind":"json-schema","title":"entitlement-value-writable-properties","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["name","externalValue"],"properties":{"name":{"$ref":"#/components/schemas/entitlement-value-display-name"},"externalValue":{"$ref":"#/components/schemas/entitlement-value-external"},"description":{"$ref":"#/components/schemas/entitlement-value-description"}},"example":{"name":"my-object-1","description":"The unique instance of my-object-1"}}},"components/schemas/entitlement-create":{"id":"components/schemas/entitlement-create","kind":"json-schema","title":"entitlement-create","data":{"description":"The properties expected in an initial add entitlement","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/entitlement-writable-properties"}],"properties":{"parent":{"$ref":"#/components/schemas/target-resource"},"values":{"type":"array","items":{"$ref":"#/components/schemas/entitlement-value-writable-properties"}}}}},"components/schemas/entitlements-full-with-parent":{"id":"components/schemas/entitlements-full-with-parent","kind":"json-schema","title":"entitlements-full-with-parent","data":{"type":"object","description":"Representation of all entitlement. Entitlement values are optional","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/entitlement-property-full"},{"$ref":"#/components/schemas/read-only-standard-properties"}],"properties":{"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"parent":{"$ref":"#/components/schemas/target-resource"},"values":{"$ref":"#/components/schemas/entitlement-values-full"},"_links":{"$ref":"#/components/schemas/entitlement-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}},"required":["id","name","externalValue","multiValue","dataType","parent","parentResourceOrn","values"]}},"components/schemas/entitlement-value-updatable":{"id":"components/schemas/entitlement-value-updatable","kind":"json-schema","title":"entitlement-value-updatable","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/entitlement-value-writable-properties"}],"x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"id":{"$ref":"#/components/schemas/entitlement-value-id"},"externalId":{"$ref":"#/components/schemas/entitlement-value-external-id"},"orn":{"$ref":"#/components/schemas/okta-entitlement-value-orn"}}}},"components/schemas/entitlement-values-updatable":{"id":"components/schemas/entitlement-values-updatable","kind":"json-schema","title":"entitlement-values-updatable","data":{"type":"array","description":"Collection of entitlement values for update operations.","items":{"$ref":"#/components/schemas/entitlement-value-updatable"}}},"components/schemas/entitlement-updatable":{"id":"components/schemas/entitlement-updatable","kind":"json-schema","title":"entitlement-updatable","data":{"type":"object","allOf":[{"$ref":"#/components/schemas/entitlement-writable-properties"}],"x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","name","externalValue","multiValue","dataType","parent","parentResourceOrn","values"],"properties":{"id":{"description":"Unique identifier for the object","type":"string","minLength":1},"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"parent":{"$ref":"#/components/schemas/target-resource"},"values":{"$ref":"#/components/schemas/entitlement-values-updatable"}}}},"components/schemas/entitlement-value-patch-op":{"id":"components/schemas/entitlement-value-patch-op","kind":"json-schema","title":"entitlement-value-patch-op","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The operation to be performed for update.","enum":["ADD","REMOVE","REPLACE"],"minLength":1}},"components/schemas/entitlement-values-patch-operation":{"id":"components/schemas/entitlement-values-patch-operation","kind":"json-schema","title":"entitlement-values-patch-operation","data":{"description":"The properties expected in an update entitlement value.","required":["op","path","refType"],"properties":{"op":{"$ref":"#/components/schemas/entitlement-value-patch-op"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path of the property being updated. ex - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/values/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMOVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPLACE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/values/-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for entitlement value update."},"children":[]}]}]}]},"value":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/entitlement-value-display-name"},"externalValue":{"$ref":"#/components/schemas/entitlement-value-external"},"description":{"$ref":"#/components/schemas/entitlement-value-description"}}},"refType":{"type":"string","enum":["ENTITLEMENT-VALUE"]}}}},"components/schemas/entitlement-patch-op":{"id":"components/schemas/entitlement-patch-op","kind":"json-schema","title":"entitlement-patch-op","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The operation to be performed for update.","enum":["ADD","REMOVE","REPLACE"],"minLength":1}},"components/schemas/entitlement-patch-operation":{"id":"components/schemas/entitlement-patch-operation","kind":"json-schema","title":"entitlement-patch-operation","data":{"description":"The properties expected in an update entitlement.","required":["op","path","refType"],"properties":{"op":{"$ref":"#/components/schemas/entitlement-patch-op"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path of the property being updated. ex - "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/description"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the entitlement update."},"children":[]}]}]}]},"value":{"type":"string","description":"The value of the property being updated."},"refType":{"type":"string","enum":["ENTITLEMENT"]}}}},"components/schemas/entitlement-patch":{"id":"components/schemas/entitlement-patch","kind":"json-schema","title":"entitlement-patch","data":{"description":"Patch properties expected in an entitlement, currently supports only entitlement value updates.","type":"array","x-okta-ignore-redocly-rules-for-sdk":true,"minItems":1,"maxItems":100,"items":{"type":"object","oneOf":[{"$ref":"#/components/schemas/entitlement-values-patch-operation"},{"$ref":"#/components/schemas/entitlement-patch-operation"}],"discriminator":{"propertyName":"refType","mapping":{"ENTITLEMENT-VALUE":"#/components/schemas/entitlement-values-patch-operation","ENTITLEMENT":"#/components/schemas/entitlement-patch-operation"}}}}},"components/schemas/label-id":{"id":"components/schemas/label-id","kind":"json-schema","title":"label-id","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The ID of a label","minLength":20,"maxLength":20}},"components/schemas/label-value-id":{"id":"components/schemas/label-value-id","kind":"json-schema","title":"label-value-id","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The ID of a label value","minLength":20,"maxLength":20}},"components/schemas/label-metadata":{"id":"components/schemas/label-metadata","kind":"json-schema","title":"label-metadata","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Metadata for a label value","properties":{"additionalProperties":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata properties for the label value."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported property and valid 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":"backgroundColor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"red"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yellow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"green"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purple"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beige"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gray"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]}],"properties":{}}}}},"components/schemas/label-value":{"id":"components/schemas/label-value","kind":"json-schema","title":"label-value","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"labelValueId":{"$ref":"#/components/schemas/label-value-id"},"name":{"type":"string","description":"The label value","minLength":1,"maxLength":50},"metadata":{"$ref":"#/components/schemas/label-metadata"}},"required":["labelValueId","name"]}},"components/schemas/link-self":{"id":"components/schemas/link-self","kind":"json-schema","title":"link-self","data":{"type":"object","description":"Links available for an object","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/label":{"id":"components/schemas/label","kind":"json-schema","title":"label","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"labelId":{"$ref":"#/components/schemas/label-id"},"name":{"type":"string","description":"Key name of the label","minLength":1,"maxLength":50},"values":{"type":"array","description":"List of label values","maxItems":10,"items":{"allOf":[{"$ref":"#/components/schemas/label-value"}]}},"_links":{"$ref":"#/components/schemas/link-self"}},"required":["labelId","name","values","_links"]}},"components/schemas/entitlement-value-with-parent":{"id":"components/schemas/entitlement-value-with-parent","kind":"json-schema","title":"entitlement-value-with-parent","data":{"type":"object","description":"Attributes related to an entitlement value","x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","name","externalValue","orn","entitlementId","parentResourceOrn","parent","created","createdBy","lastUpdated","lastUpdatedBy"],"properties":{"id":{"$ref":"#/components/schemas/entitlement-value-id"},"name":{"$ref":"#/components/schemas/entitlement-value-display-name"},"externalValue":{"$ref":"#/components/schemas/entitlement-value-external"},"externalId":{"$ref":"#/components/schemas/entitlement-value-external-id"},"description":{"$ref":"#/components/schemas/entitlement-value-description"},"orn":{"$ref":"#/components/schemas/okta-entitlement-value-orn"},"entitlementId":{"$ref":"#/components/schemas/entitlement-property-id"},"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"parent":{"$ref":"#/components/schemas/target-resource"},"createdBy":{"$ref":"#/components/schemas/created-by"},"created":{"$ref":"#/components/schemas/created"},"lastUpdated":{"$ref":"#/components/schemas/last-updated"},"lastUpdatedBy":{"$ref":"#/components/schemas/last-updated-by"},"_links":{"type":"object","description":"Links to related resources","additionalProperties":{"$ref":"#/components/schemas/link"}},"labels":{"type":"array","description":"List of assigned labels","maxItems":10,"items":{"$ref":"#/components/schemas/label"}}}}},"components/schemas/entitlement-values-list":{"id":"components/schemas/entitlement-values-list","kind":"json-schema","title":"entitlement-values-list","data":{"type":"object","properties":{"data":{"description":"List of entitlement values matching the filter","type":"array","items":{"$ref":"#/components/schemas/entitlement-value-with-parent"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/entitlement-link":{"id":"components/schemas/entitlement-link","kind":"json-schema","title":"entitlement-link","data":{"type":"object","description":"Links available in entitlements list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/entitlement-value-2":{"id":"components/schemas/entitlement-value-2","kind":"json-schema","title":"entitlement-value-2","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","name","externalValue","entitlementId","parentResourceOrn","parent","_links"],"allOf":[{"$ref":"#/components/schemas/entitlement-value-with-parent"},{"$ref":"#/components/schemas/read-only-standard-properties"}],"properties":{"_links":{"$ref":"#/components/schemas/entitlement-link"}}}},"components/schemas/entitlement-drift-id":{"id":"components/schemas/entitlement-drift-id","kind":"json-schema","title":"entitlement-drift-id","data":{"type":"string","description":"The unique ID of the entitlement drift","minLength":1,"maxLength":20}},"components/schemas/entitlement-drift-import-job-id":{"id":"components/schemas/entitlement-drift-import-job-id","kind":"json-schema","title":"entitlement-drift-import-job-id","data":{"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the import job that surfaced this drift"},"children":[]}]}]}],"minLength":1,"maxLength":64}},"components/schemas/entitlement-drift-type":{"id":"components/schemas/entitlement-drift-type","kind":"json-schema","title":"entitlement-drift-type","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Which way the entitlement drifted, compared to what Okta governed before this import."},"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":"ADD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The import has an entitlement that Okta wasn't governing."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta was governing an entitlement that's missing from the import."},"children":[]}]}]}]}],"enum":["ADD","SUB"],"x-enumDescriptions":{"ADD":"The import has an entitlement that Okta wasn't governing.","SUB":"Okta was governing an entitlement that's missing from the import."}}},"components/schemas/entitlement-drift-status":{"id":"components/schemas/entitlement-drift-status","kind":"json-schema","title":"entitlement-drift-status","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where the drift is in its lifecycle."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta has decided how to resolve the drift and is still applying it:"},"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":"AUTO_ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta accepted the change and is applying it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTO_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta rejected the change and is restoring the original assignment in the app."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The change tried to remove a birthright entitlement ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POLICY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENT-BUNDLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), so Okta is restoring the original assignment."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Finished:"},"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":"APPLIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": The drift is resolved and any change to the app is complete."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REVERTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": An admin undid an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLIED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" + "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTO_ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" drift. You can't revert rejected or conflict-rejected drifts."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUPERSEDED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": A later reconciliation cycle for the same resource, principal, and entitlement replaced this drift, so it no longer reflects the current state."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Failed:"},"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":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta couldn't finish resolving the drift. This isn't final. The next reconciliation cycle for the same resource, principal, and entitlement supersedes it."},"children":[]}]}]}]}],"enum":["AUTO_ACCEPTED","AUTO_REJECTED","CONFLICT_REJECTED","APPLIED","REVERTED","SUPERSEDED","ERROR"],"x-enumDescriptions":{"AUTO_ACCEPTED":"Okta accepted the change and is applying it.","AUTO_REJECTED":"Okta rejected the change and is restoring the original assignment.","CONFLICT_REJECTED":"The change tried to remove a birthright entitlement, so Okta is restoring the original assignment.","APPLIED":"Resolved. Any change to the app is complete.","REVERTED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"An admin undid an APPLIED, AUTO_ACCEPTED drift."},"children":[]}]}]}],"SUPERSEDED":"Replaced by a later reconciliation cycle for the same resource, principal, and entitlement.","ERROR":"Okta couldn't finish resolving the drift. The next cycle supersedes it."}}},"components/schemas/entitlement-drift-resolution":{"id":"components/schemas/entitlement-drift-resolution","kind":"json-schema","title":"entitlement-drift-resolution","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"How Okta resolved the drift."},"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":"AUTO_ACCEPTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta honored the change. An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" removes the entitlement from the grant that provided it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AUTO_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta rejected the change, based on the action that was configured for that direction, and pushed the original assignment back to the app."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta rejected a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" because the entitlement came from a birthright source ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POLICY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENT-BUNDLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"), which it never removes, and pushed the original assignment back to the app."},"children":[]}]}]}]}],"enum":["AUTO_ACCEPTED","AUTO_REJECTED","CONFLICT_REJECTED"],"x-enumDescriptions":{"AUTO_ACCEPTED":"Okta honored the change.","AUTO_REJECTED":"Okta rejected the change and pushed the original assignment back to the app.","CONFLICT_REJECTED":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta rejected a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on a birthright source and pushed the original assignment back to the app."},"children":[]}]}]}]}}},"components/schemas/entitlement-drift-entitlement-reference":{"id":"components/schemas/entitlement-drift-entitlement-reference","kind":"json-schema","title":"entitlement-drift-entitlement-reference","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Identifies the entitlement the drift is about. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"schemaPropertyId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is always present and names the entitlement property the drift applies to. At least one of "},"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":"value"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"externalId"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is also present."},"children":[]}]}]}],"required":["schemaPropertyId"],"properties":{"schemaPropertyId":{"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the entitlement property the drift applies to"},"children":[]}]}]}],"minLength":1,"maxLength":20},"id":{"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the entitlement value, after Okta has registered it"},"children":[]}]}]}],"maxLength":20},"value":{"type":"string","description":"The entitlement value as seen in the import, or as Okta governed it before this import","maxLength":1024},"externalId":{"type":"string","description":"The entitlement value's ID in the source app","maxLength":1024}}}},"components/schemas/entitlement-drift-affected-grant-source":{"id":"components/schemas/entitlement-drift-affected-grant-source","kind":"json-schema","title":"entitlement-drift-affected-grant-source","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Where the affected entitlement's grant came from when the drift was detected. "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POLICY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENT-BUNDLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are birthright sources: a user gets them automatically, and reconciliation never removes them."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Because Okta never removes a birthright entitlement, a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POLICY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source is always "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"CONFLICT_REJECTED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from an "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENT-BUNDLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" source is too, with one exception: if the import removes every entitlement the bundle granted, Okta accepts the removals and drops the whole bundle grant."},"children":[]}]}]}],"enum":["POLICY","CUSTOM","ENTITLEMENT-BUNDLE","ENTITLEMENT","IMPORT"],"x-enumDescriptions":{"POLICY":"Birthright is granted automatically by an access policy.","CUSTOM":"Granted directly by an admin, the API, an app-level access request, or a legacy-mode import","ENTITLEMENT-BUNDLE":"Birthright is granted through an entitlement bundle.","ENTITLEMENT":"Granted by an admin or a collection assignment","IMPORT":"Created by an earlier reconciliation cycle"}}},"components/schemas/entitlement-drift-affected-grant-id":{"id":"components/schemas/entitlement-drift-affected-grant-id","kind":"json-schema","title":"entitlement-drift-affected-grant-id","data":{"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the grant that held the affected entitlement when the drift was detected."},"children":[]}]}]}],"maxLength":20}},"components/schemas/entitlement-drift-resolved-grant-id":{"id":"components/schemas/entitlement-drift-resolved-grant-id","kind":"json-schema","title":"entitlement-drift-resolved-grant-id","data":{"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":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the grant that resolution created or changed."},"children":[]}]}]}],"maxLength":20}},"components/schemas/entitlement-drift-reverted-at":{"id":"components/schemas/entitlement-drift-reverted-at","kind":"json-schema","title":"entitlement-drift-reverted-at","data":{"type":"string","format":"date-time","description":"When the drift was reverted. Present only on a reverted drift."}},"components/schemas/entitlement-drift-reverted-by":{"id":"components/schemas/entitlement-drift-reverted-by","kind":"json-schema","title":"entitlement-drift-reverted-by","data":{"type":"string","description":"The principal who reverted the drift. Present only on a reverted drift."}},"components/schemas/entitlement-drift-error-message":{"id":"components/schemas/entitlement-drift-error-message","kind":"json-schema","title":"entitlement-drift-error-message","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A message that explains why Okta couldn't resolve the drift. Present only when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"status"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ERROR"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":1024}},"components/schemas/entitlement-drift-links":{"id":"components/schemas/entitlement-drift-links","kind":"json-schema","title":"entitlement-drift-links","data":{"type":"object","description":"Links to this drift and its related resources","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"revert":{"$ref":"#/components/schemas/link"},"resource":{"$ref":"#/components/schemas/link"},"principal":{"$ref":"#/components/schemas/link"}}}},"components/schemas/entitlement-drift-full":{"id":"components/schemas/entitlement-drift-full","kind":"json-schema","title":"entitlement-drift-full","data":{"description":"A single entitlement drift, in full","allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"type":"object","required":["resourceOrn","principalOrn","importJobId","driftType","status","resolution","entitlement","_links"],"properties":{"resourceOrn":{"$ref":"#/components/schemas/resource-orn"},"principalOrn":{"$ref":"#/components/schemas/user-orn"},"importJobId":{"$ref":"#/components/schemas/entitlement-drift-import-job-id"},"driftType":{"$ref":"#/components/schemas/entitlement-drift-type"},"status":{"$ref":"#/components/schemas/entitlement-drift-status"},"resolution":{"$ref":"#/components/schemas/entitlement-drift-resolution"},"entitlement":{"$ref":"#/components/schemas/entitlement-drift-entitlement-reference"},"affectedGrantSource":{"$ref":"#/components/schemas/entitlement-drift-affected-grant-source"},"affectedGrantId":{"$ref":"#/components/schemas/entitlement-drift-affected-grant-id"},"resolvedGrantId":{"$ref":"#/components/schemas/entitlement-drift-resolved-grant-id"},"revertedAt":{"$ref":"#/components/schemas/entitlement-drift-reverted-at"},"revertedBy":{"$ref":"#/components/schemas/entitlement-drift-reverted-by"},"errorMessage":{"$ref":"#/components/schemas/entitlement-drift-error-message"},"_links":{"$ref":"#/components/schemas/entitlement-drift-links"}}}]}},"components/schemas/entitlement-drift-list-links":{"id":"components/schemas/entitlement-drift-list-links","kind":"json-schema","title":"entitlement-drift-list-links","data":{"type":"object","description":"Links for navigating the list of drifts","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/entitlement-drifts-list":{"id":"components/schemas/entitlement-drifts-list","kind":"json-schema","title":"entitlement-drifts-list","data":{"type":"object","description":"A page of entitlement drifts","properties":{"data":{"description":"The drifts on this page","type":"array","items":{"$ref":"#/components/schemas/entitlement-drift-full"}},"_links":{"$ref":"#/components/schemas/entitlement-drift-list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/reconciliation-mode":{"id":"components/schemas/reconciliation-mode","kind":"json-schema","title":"reconciliation-mode","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Whether reconciliation runs for this 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":"code","inline":true,"attributes":{"content":"DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Reconciliation is off. Entitlement imports create grants the same way they did before reconciliation existed."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta detects drift on each import, resolves it, and pushes any change back to the app."},"children":[]}]}]}]}],"enum":["DISABLED","ENABLED"],"x-enumDescriptions":{"DISABLED":"Reconciliation is off. Imports create grants the way that they did before reconciliation existed.","ENABLED":"Okta detects drift, resolves it, and pushes any change back to the application"}}},"components/schemas/reconciliation-default-action":{"id":"components/schemas/reconciliation-default-action","kind":"json-schema","title":"reconciliation-default-action","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The action Okta takes in both directions when you don't set a per-direction override. Required."},"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":"ACCEPT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta honors the change. An "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" becomes a new "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"IMPORT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" grant. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" from a non-birthright source removes the entitlement from the grant that provided it."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta rejects the change and pushes the original assignment back to the app."},"children":[]}]}]}]}],"enum":["ACCEPT","REJECT"],"x-enumDescriptions":{"ACCEPT":"Okta honors the change.","REJECT":"Okta rejects the change and pushes the original assignment back to the app."}}},"components/schemas/reconciliation-direction-action":{"id":"components/schemas/reconciliation-direction-action","kind":"json-schema","title":"reconciliation-direction-action","data":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Overrides "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for one direction. Optional. When omitted, that direction uses "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"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":"ACCEPT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta honors the change."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REJECT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Okta rejects the change and pushes the original assignment back to the app."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This override never lifts birthright protection. A "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"SUB"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" on an entitlement from a birthright source ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"POLICY"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENT-BUNDLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") is conflict-rejected."},"children":[]}]}]}],"enum":["ACCEPT","REJECT"],"x-enumDescriptions":{"ACCEPT":"Okta honors the change.","REJECT":"Okta rejects the change and pushes the original assignment back to the app."}}},"components/schemas/entitlement-reconciliation-config-links":{"id":"components/schemas/entitlement-reconciliation-config-links","kind":"json-schema","title":"entitlement-reconciliation-config-links","data":{"type":"object","description":"Links to this configuration and its resource","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"resource":{"$ref":"#/components/schemas/link"}}}},"components/schemas/entitlement-reconciliation-config-full":{"id":"components/schemas/entitlement-reconciliation-config-full","kind":"json-schema","title":"entitlement-reconciliation-config-full","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A resource's reconciliation configuration."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the resource has no saved configuration, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"getEntitlementReconciliationConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" returns a default "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DISABLED"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" configuration with only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"mode"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"_links"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" set. After a configuration is saved, the response also includes the audit fields ("},"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":"created"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"createdBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastUpdated"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"lastUpdatedBy"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":") and the actions ("},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"defaultAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", plus the optional "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"additiveAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"subtractiveAction"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"). A successful "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"upsertEntitlementReconciliationConfig"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" always returns the full configuration."},"children":[]}]}]}],"required":["mode","resourceOrn","_links"],"properties":{"id":{"description":"The unique ID of the configuration. Present only after a configuration has been saved for the resource.","type":"string","minLength":1},"createdBy":{"$ref":"#/components/schemas/created-by"},"created":{"$ref":"#/components/schemas/created"},"lastUpdated":{"$ref":"#/components/schemas/last-updated"},"lastUpdatedBy":{"$ref":"#/components/schemas/last-updated-by"},"mode":{"$ref":"#/components/schemas/reconciliation-mode"},"defaultAction":{"$ref":"#/components/schemas/reconciliation-default-action"},"additiveAction":{"$ref":"#/components/schemas/reconciliation-direction-action"},"subtractiveAction":{"$ref":"#/components/schemas/reconciliation-direction-action"},"resourceOrn":{"$ref":"#/components/schemas/resource-orn"},"_links":{"$ref":"#/components/schemas/entitlement-reconciliation-config-links"}}}},"components/schemas/entitlement-reconciliation-config-writable":{"id":"components/schemas/entitlement-reconciliation-config-writable","kind":"json-schema","title":"entitlement-reconciliation-config-writable","data":{"type":"object","description":"The fields that you can set on a reconciliation configuration.","required":["mode","defaultAction"],"properties":{"mode":{"$ref":"#/components/schemas/reconciliation-mode"},"defaultAction":{"$ref":"#/components/schemas/reconciliation-default-action"},"additiveAction":{"$ref":"#/components/schemas/reconciliation-direction-action"},"subtractiveAction":{"$ref":"#/components/schemas/reconciliation-direction-action"}}}},"components/schemas/principal-entitlement":{"id":"components/schemas/principal-entitlement","kind":"json-schema","title":"principal-entitlement","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/entitlement-property-full"}],"properties":{"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"parent":{"$ref":"#/components/schemas/target-resource"},"values":{"$ref":"#/components/schemas/entitlement-values-full"},"targetPrincipalOrn":{"$ref":"#/components/schemas/user-orn"},"targetPrincipal":{"$ref":"#/components/schemas/target-principal-full"}}}},"components/schemas/principal-entitlements-list-links":{"id":"components/schemas/principal-entitlements-list-links","kind":"json-schema","title":"principal-entitlements-list-links","data":{"type":"object","description":"Links available in user entitlements list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/principal-entitlements-list":{"id":"components/schemas/principal-entitlements-list","kind":"json-schema","title":"principal-entitlements-list","data":{"type":"object","properties":{"data":{"description":"Principal entitlements list","type":"array","items":{"$ref":"#/components/schemas/principal-entitlement"}},"_links":{"$ref":"#/components/schemas/principal-entitlements-list-links"}}}},"components/schemas/entitlement-value-changed":{"id":"components/schemas/entitlement-value-changed","kind":"json-schema","title":"entitlement-value-changed","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Attributes related to an entitlement value","allOf":[{"$ref":"#/components/schemas/entitlement-value-full"}],"properties":{"changeType":{"type":"string","description":"Type of change that occurred to the entitlement","enum":["ADDED","REMOVED"]}}}},"components/schemas/entitlement-changed-full":{"id":"components/schemas/entitlement-changed-full","kind":"json-schema","title":"entitlement-changed-full","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"All entitlements with the property values","allOf":[{"$ref":"#/components/schemas/entitlement-property-full"}],"required":["id"],"properties":{"values":{"type":"array","description":"List of changed entitlement values","items":{"$ref":"#/components/schemas/entitlement-value-changed"}}}}},"components/schemas/principal-entitlements-change-links":{"id":"components/schemas/principal-entitlements-change-links","kind":"json-schema","title":"principal-entitlements-change-links","data":{"type":"object","description":"Link to current effective entitlements","required":["principal-entitlements"],"properties":{"principal-entitlements":{"$ref":"#/components/schemas/link"}}}},"components/schemas/principal-entitlements-change":{"id":"components/schemas/principal-entitlements-change","kind":"json-schema","title":"principal-entitlements-change","data":{"type":"object","properties":{"entitlementsChanged":{"type":"array","description":"List of changed entitlements","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/entitlement-changed-full"}},"resourceOrn":{"$ref":"#/components/schemas/resource-orn"},"resource":{"$ref":"#/components/schemas/target-resource"},"principalOrn":{"$ref":"#/components/schemas/user-orn"},"principal":{"$ref":"#/components/schemas/target-principal-full"},"_links":{"$ref":"#/components/schemas/principal-entitlements-change-links"}}}},"components/schemas/entitlement-history-id":{"id":"components/schemas/entitlement-history-id","kind":"json-schema","title":"entitlement-history-id","data":{"type":"string","maxLength":20,"minLength":20,"pattern":"gra[0-9a-zA-Z]+","description":"Unique identifier for an entitlement history entry"}},"components/schemas/entitlement-detail":{"id":"components/schemas/entitlement-detail","kind":"json-schema","title":"entitlement-detail","data":{"type":"object","description":"A single entitlement entry in the entitlements list of one historical record","allOf":[{"$ref":"#/components/schemas/entitlement-property-full"}],"x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"values":{"$ref":"#/components/schemas/entitlement-values-full"}}}},"components/schemas/entitlement-history-record":{"id":"components/schemas/entitlement-history-record","kind":"json-schema","title":"entitlement-history-record","data":{"type":"object","description":"A single entry in the entitlement history, showing all effective entitlements at a specific point in time.","properties":{"id":{"$ref":"#/components/schemas/entitlement-history-id"},"startDate":{"type":"string","format":"date-time","description":"The start date and time when the entitlements became effective"},"endDate":{"type":"string","format":"date-time","description":"The end date and time when the entitlements were superseded (if empty, the entitlements are currently effective)"},"lifecycle":{"type":"string","description":"The current status of the entitlements for this history entry","enum":["ACTIVE","INACTIVE","SCHEDULED","EXPIRED"]},"entitlements":{"type":"array","description":"List of entitlements for this history entry","items":{"$ref":"#/components/schemas/entitlement-detail"}}}}},"components/schemas/principal-entitlements-history":{"id":"components/schemas/principal-entitlements-history","kind":"json-schema","title":"principal-entitlements-history","data":{"type":"object","properties":{"resourceOrn":{"$ref":"#/components/schemas/resource-orn"},"resource":{"$ref":"#/components/schemas/target-resource"},"principalOrn":{"$ref":"#/components/schemas/user-orn"},"principal":{"$ref":"#/components/schemas/target-principal-full"},"entitlementHistory":{"description":"Principal entitlements history list","minItems":0,"maxItems":100,"type":"array","items":{"$ref":"#/components/schemas/entitlement-history-record"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/grantMethod":{"id":"components/schemas/grantMethod","kind":"json-schema","title":"grantMethod","data":{"type":"string","enum":["POLICY","ACCESS_REQUEST","ADMIN","API","NONE","IMPORT"],"description":"Type of grant assignment method"}},"components/schemas/grant-id":{"id":"components/schemas/grant-id","kind":"json-schema","title":"grant-id","data":{"type":"string","maxLength":20,"minLength":20,"format":"grant-id","pattern":"gra[0-9a-zA-Z]+","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Grant "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}]}},"components/schemas/grant-details":{"id":"components/schemas/grant-details","kind":"json-schema","title":"grant-details","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/grant-id"},"metadata":{"$ref":"#/components/schemas/grant-metadata"},"_links":{"properties":{"self":{"$ref":"#/components/schemas/link"}}}}}},"components/schemas/entitlement-bundle-name":{"id":"components/schemas/entitlement-bundle-name","kind":"json-schema","title":"entitlement-bundle-name","data":{"type":"string","nullable":false,"description":"The unique name of the entitlement bundle","maxLength":255,"minLength":1}},"components/schemas/bundle":{"id":"components/schemas/bundle","kind":"json-schema","title":"bundle","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/entitlement-bundle-id"},"name":{"$ref":"#/components/schemas/entitlement-bundle-name"}},"required":["id","name"]}},"components/schemas/granted-entitlement-value":{"id":"components/schemas/granted-entitlement-value","kind":"json-schema","title":"granted-entitlement-value","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/entitlement-value-id"},"name":{"$ref":"#/components/schemas/entitlement-value-display-name"},"externalValue":{"$ref":"#/components/schemas/entitlement-value-external"},"orn":{"$ref":"#/components/schemas/okta-entitlement-value-orn"},"effective":{"type":"boolean","description":"A granted entitlement may not be effective if the same entitlement is granted by a higher priority additional grant"}},"required":["id","name","externalValue","orn"]}},"components/schemas/granted-entitlements":{"id":"components/schemas/granted-entitlements","kind":"json-schema","title":"granted-entitlements","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","name","externalValue","multiValue","required","dataType","values"],"allOf":[{"$ref":"#/components/schemas/entitlement-property-full"}],"properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/granted-entitlement-value"}}}}},"components/schemas/grant":{"id":"components/schemas/grant","kind":"json-schema","title":"grant","data":{"type":"object","description":"representation of a base grant","required":["grantType","grant","entitlements"],"properties":{"grantMethod":{"$ref":"#/components/schemas/grantMethod","readOnly":true},"grantType":{"$ref":"#/components/schemas/grant-type","readOnly":true},"startTime":{"type":"string","description":"The date on which the user received an access. Date in ISO 8601 format.","format":"date-time"},"expirationTime":{"type":"string","description":"The date on which the user access expires. Date in ISO 8601 format.","format":"date-time"},"timeZone":{"type":"string","description":"The time zone, in IANA format, for the end date of the user access.","minLength":1,"maxLength":64},"grant":{"$ref":"#/components/schemas/grant-details"},"bundle":{"$ref":"#/components/schemas/bundle"},"entitlements":{"type":"array","items":{"$ref":"#/components/schemas/granted-entitlements"}}}}},"components/schemas/principal-access":{"id":"components/schemas/principal-access","kind":"json-schema","title":"principal-access","data":{"type":"object","description":"Full representation of a principal access","required":["parentResourceOrn","parent","targetPrincipalOrn","targetPrincipal"],"properties":{"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"parent":{"$ref":"#/components/schemas/target-resource"},"targetPrincipalOrn":{"$ref":"#/components/schemas/user-orn"},"targetPrincipal":{"$ref":"#/components/schemas/target-principal-full"},"expirationTime":{"type":"string","description":"The date on which the user access expires. Date in ISO 8601 format.","format":"date-time"},"timeZone":{"type":"string","description":"The time zone, in IANA format, for the end date of the user access.","minLength":1,"maxLength":64},"base":{"$ref":"#/components/schemas/grant"},"additional":{"type":"array","items":{"$ref":"#/components/schemas/grant"}}}}},"components/schemas/scoped-entitlement-resource-asset":{"id":"components/schemas/scoped-entitlement-resource-asset","kind":"json-schema","title":"scoped-entitlement-resource-asset","data":{"type":"object","description":"A resource asset associated with a scoped entitlement","required":["id","orn","type","name"],"properties":{"id":{"type":"string","description":"The identifier of the resource asset","minLength":1,"maxLength":512},"orn":{"$ref":"#/components/schemas/resource-orn"},"type":{"$ref":"#/components/schemas/resource-asset-type-sparse"},"name":{"$ref":"#/components/schemas/resource-asset-name"}}}},"components/schemas/scoped-entitlement-item":{"id":"components/schemas/scoped-entitlement-item","kind":"json-schema","title":"scoped-entitlement-item","data":{"type":"object","description":"A scoped entitlement grouping entitlements under a specific resource asset","required":["resourceAssetId","resourceAsset","entitlements"],"properties":{"resourceAssetId":{"type":"string","description":"The identifier of the resource asset associated with this scoped entitlement"},"resourceAsset":{"$ref":"#/components/schemas/scoped-entitlement-resource-asset"},"entitlements":{"type":"array","description":"Entitlements associated with this resource asset","items":{"$ref":"#/components/schemas/entitlement-full"}}}}},"components/schemas/indirect-access":{"id":"components/schemas/indirect-access","kind":"json-schema","title":"indirect-access","data":{"type":"object","description":"Access obtained indirectly through group membership or resource asset hierarchy including the entitlements","required":["grant","scopedEntitlements"],"properties":{"grant":{"$ref":"#/components/schemas/grant-details"},"scopedEntitlements":{"type":"array","description":"Entitlements obtained through this grant grouped by resource asset scope","minItems":1,"items":{"$ref":"#/components/schemas/scoped-entitlement-item"}}}}},"components/schemas/indirect-access-list":{"id":"components/schemas/indirect-access-list","kind":"json-schema","title":"indirect-access-list","data":{"type":"object","description":"Paginated list of indirect access","properties":{"data":{"type":"array","description":"Array of indirect access","items":{"$ref":"#/components/schemas/indirect-access"},"minItems":0},"_links":{"$ref":"#/components/schemas/list-links"}}}},"components/schemas/merge-existing-entitlements":{"id":"components/schemas/merge-existing-entitlements","kind":"json-schema","title":"merge-existing-entitlements","data":{"type":"boolean","description":"If true, would skip removing bundle grant and create an entitlement grant with delta. By default it is false."}},"components/schemas/principal-access-policy-enable-creatable":{"id":"components/schemas/principal-access-policy-enable-creatable","kind":"json-schema","title":"principal-access-policy-enable-creatable","data":{"type":"object","required":["principalOrn","resourceOrn"],"properties":{"principalOrn":{"$ref":"#/components/schemas/user-orn"},"resourceOrn":{"$ref":"#/components/schemas/resource-orn"},"mergeExistingEntitlements":{"$ref":"#/components/schemas/merge-existing-entitlements"}}}},"components/schemas/assignment-properties":{"id":"components/schemas/assignment-properties","kind":"json-schema","title":"assignment-properties","data":{"properties":{"expirationTime":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The date on which the principal's access expires. This property is specified in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://en.wikipedia.org/wiki/ISO_8601#Durations"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"ISO 8601 duration format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"format":"date-time"},"timeZone":{"type":"string","description":"The time zone, in IANA format, for the end date of the user access","minLength":1,"maxLength":64}}}},"components/schemas/assignment-object-type":{"id":"components/schemas/assignment-object-type","kind":"json-schema","title":"assignment-object-type","data":{"type":"string","description":"Identifies assignment type. assignmentObject will be present when assignmentObjectType is Bundle or Collection.","enum":["ENTITLEMENT_BUNDLE","COLLECTION","ENTITLEMENT"]}},"components/schemas/assignment-object-id":{"id":"components/schemas/assignment-object-id","kind":"json-schema","title":"assignment-object-id","data":{"description":"Unique identifier of assignmentObject","type":"string","minLength":1,"maxLength":20}},"components/schemas/assignment-object-orn":{"id":"components/schemas/assignment-object-orn","kind":"json-schema","title":"assignment-object-orn","data":{"type":"string","format":"okta-resource-orn","description":"ORN of the assignmentObject"}},"components/schemas/assignment-object-name":{"id":"components/schemas/assignment-object-name","kind":"json-schema","title":"assignment-object-name","data":{"type":"string","description":"The name of the assignmentObject","minLength":1,"maxLength":255}},"components/schemas/assignment-object-description":{"id":"components/schemas/assignment-object-description","kind":"json-schema","title":"assignment-object-description","data":{"type":"string","nullable":false,"description":"The human-readable description of the assignmentObject","maxLength":1000,"minLength":1}},"components/schemas/assignment-object":{"id":"components/schemas/assignment-object","kind":"json-schema","title":"assignment-object","data":{"type":"object","description":"Assignment object","properties":{"id":{"$ref":"#/components/schemas/assignment-object-id"},"orn":{"$ref":"#/components/schemas/assignment-object-orn"},"name":{"$ref":"#/components/schemas/assignment-object-name"},"description":{"$ref":"#/components/schemas/assignment-object-description"}}}},"components/schemas/assignment-method":{"id":"components/schemas/assignment-method","kind":"json-schema","title":"assignment-method","data":{"type":"string","description":"Assignment method","enum":["POLICY","ACCESS_REQUEST","ADMIN","API"]}},"components/schemas/grant-object":{"id":"components/schemas/grant-object","kind":"json-schema","title":"grant-object","data":{"type":"object","description":"Unique identifier for the object","properties":{"id":{"description":"Unique identifier for the object","type":"string","minLength":1}}}},"components/schemas/entitlement-access-details-object":{"id":"components/schemas/entitlement-access-details-object","kind":"json-schema","title":"entitlement-access-details-object","data":{"type":"object","description":"Entitlement access details","required":["entitlements","assignmentObjectType","assignmentMethod"],"properties":{"assignmentObjectType":{"$ref":"#/components/schemas/assignment-object-type"},"assignmentObject":{"$ref":"#/components/schemas/assignment-object"},"assignmentMethod":{"$ref":"#/components/schemas/assignment-method"},"entitlements":{"$ref":"#/components/schemas/entitlements-full"},"accessDuration":{"$ref":"#/components/schemas/assignment-properties"},"grant":{"$ref":"#/components/schemas/grant-object"}}}},"components/schemas/entitlement-access-details-list":{"id":"components/schemas/entitlement-access-details-list","kind":"json-schema","title":"entitlement-access-details-list","data":{"type":"array","description":"Entitlement access details","nullable":false,"items":{"$ref":"#/components/schemas/entitlement-access-details-object"}}},"components/schemas/principal-access-policy-enable-response":{"id":"components/schemas/principal-access-policy-enable-response","kind":"json-schema","title":"principal-access-policy-enable-response","data":{"description":"Principal access policy enable","required":["principalOrn","resourceOrn","effectiveEntitlements"],"properties":{"principalOrn":{"$ref":"#/components/schemas/user-orn"},"resourceOrn":{"$ref":"#/components/schemas/resource-orn"},"accessDuration":{"$ref":"#/components/schemas/assignment-properties"},"effectiveEntitlements":{"$ref":"#/components/schemas/entitlements-full"},"entitlementAccessDetails":{"$ref":"#/components/schemas/entitlement-access-details-list"}}}},"components/schemas/entitlement-settings-response-status":{"id":"components/schemas/entitlement-settings-response-status","kind":"json-schema","title":"entitlement-settings-response-status","data":{"type":"string","enum":["OPTING_IN","OPTED_IN","OPTING_OUT","OPTED_OUT"],"description":"The status showing whether the resource is opted in to (enabled) or out of (disabled) entitlement management","x-enumDescriptions":{"OPTING_IN":"The resource is in the process of opting in to entitlement management","OPTED_IN":"The resource is opted in to entitlement management","OPTING_OUT":"The resource is in the process of opting out of entitlement management","OPTED_OUT":"The resource is opted out of the entitlement management"}}},"components/schemas/entitlement-settings-full":{"id":"components/schemas/entitlement-settings-full","kind":"json-schema","title":"entitlement-settings-full","data":{"description":"Entitlement settings for a resource","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/entitlement-settings-response-status"}}}},"components/schemas/entitlement-settings-request-status":{"id":"components/schemas/entitlement-settings-request-status","kind":"json-schema","title":"entitlement-settings-request-status","data":{"type":"string","enum":["OPTED_IN","OPTED_OUT"],"x-enum-varnames":["OPTED_IN","OPTED_OUT"],"description":"Specify to opt in (enable) or opt out of (disable) entitlement management for the resource"}},"components/schemas/entitlement-settings-updatable":{"id":"components/schemas/entitlement-settings-updatable","kind":"json-schema","title":"entitlement-settings-updatable","data":{"type":"object","required":["status"],"properties":{"status":{"$ref":"#/components/schemas/entitlement-settings-request-status"}}}},"components/schemas/access-duration":{"id":"components/schemas/access-duration","kind":"json-schema","title":"access-duration","data":{"type":"object","description":"Specifies the duration of access with an expiration time and timezone","required":["expirationTime","timezone"],"properties":{"expirationTime":{"type":"string","format":"date-time","description":"The date and time when access expires, in ISO 8601 format","example":"2025-12-31T23:59:59Z"},"timezone":{"type":"string","description":"The timezone for the expiration time, in IANA format","minLength":1,"maxLength":64,"example":"America/Los_Angeles"}}}},"components/schemas/grant-principal-entitlement-group":{"id":"components/schemas/grant-principal-entitlement-group","kind":"json-schema","title":"grant-principal-entitlement-group","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A group of entitlement values optionally scoped to a resource asset."},"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":"resourceAssetOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is omitted, the entitlements are at the app level."},"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":"resourceAssetOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is present, the entitlements are scoped to that specific resource asset."},"children":[]}]}]}],"required":["entitlementValueOrns"],"properties":{"resourceAssetOrn":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-resource-orn","description":"The ORN of the resource asset to scope the entitlements to.\nOmit this field for app-level entitlements that aren't tied to a specific resource asset.","example":"orn:okta:governance:00o11edPwGqbUrsDm0g4:resource-assets:reafxqCAJWWGELFTYASJ"},"entitlementValueOrns":{"type":"array","description":"List of entitlement value ORNs to grant within this scope","minItems":1,"maxItems":50,"items":{"type":"string","format":"okta-resource-orn","description":"The ORN of an entitlement value","example":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:env1o5jo0bHpxiDVJ0g5"}}}}},"components/schemas/grant-principal-entitlement-data-entitlement":{"id":"components/schemas/grant-principal-entitlement-data-entitlement","kind":"json-schema","title":"grant-principal-entitlement-data-entitlement","data":{"type":"object","description":"Entitlement data for direct entitlement assignment.\nEntitlements can be grouped by resource asset scope. Each group contains\none or more entitlement values to grant.","required":["type","entitlements"],"properties":{"type":{"type":"string","enum":["ENTITLEMENT"],"description":"Indicates direct entitlement assignment"},"entitlements":{"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 entitlement data. Each entry optionally specifies a resource asset scope."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Entry without "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceAssetOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" represent app-level entitlements."},"children":[]}]}]}],"minItems":1,"maxItems":5,"items":{"$ref":"#/components/schemas/grant-principal-entitlement-group"}},"accessDuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of access for the entitlements. Independent of the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accessDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that controls the app assignment duration."},"children":[]}]}]}],"$ref":"#/components/schemas/access-duration"}}}},"components/schemas/grant-principal-entitlement-data-bundle":{"id":"components/schemas/grant-principal-entitlement-data-bundle","kind":"json-schema","title":"grant-principal-entitlement-data-bundle","data":{"type":"object","description":"Entitlement data for entitlement bundle assignment.\nThe server resolves the bundle contents to determine the actual entitlements to grant.","required":["type","entitlementBundleOrn"],"properties":{"type":{"type":"string","enum":["ENTITLEMENT_BUNDLE"],"description":"Indicates entitlement bundle assignment"},"entitlementBundleOrn":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-resource-orn","description":"The ORN of the entitlement bundle to grant","example":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enb1o5jmfBTZUCzcW0g5"},"accessDuration":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Duration of access for the entitlement bundle. Independent of the top-level "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accessDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" that controls the app assignment duration."},"children":[]}]}]}],"$ref":"#/components/schemas/access-duration"}}}},"components/schemas/grant-principal-entitlement-data":{"id":"components/schemas/grant-principal-entitlement-data","kind":"json-schema","title":"grant-principal-entitlement-data","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Specifies the entitlements to grant to the principal. Discriminated by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"type"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":":"},"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":"ENTITLEMENT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Direct entitlement assignment with grouped entitlement values"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENT_BUNDLE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": Entitlement bundle assignment"},"children":[]}]}]}]}],"oneOf":[{"$ref":"#/components/schemas/grant-principal-entitlement-data-entitlement"},{"$ref":"#/components/schemas/grant-principal-entitlement-data-bundle"}],"discriminator":{"propertyName":"type","mapping":{"ENTITLEMENT":"#/components/schemas/grant-principal-entitlement-data-entitlement","ENTITLEMENT_BUNDLE":"#/components/schemas/grant-principal-entitlement-data-bundle"}}}},"components/schemas/grant-principal-access-request":{"id":"components/schemas/grant-principal-access-request","kind":"json-schema","title":"grant-principal-access-request","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Request body for granting a principal access to a resource."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"At minimum, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" are required to grant app-level access."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Optionally, specify "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlementData"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to grant specific entitlements or bundles,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"accessDuration"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to set an expiration on the app assignment."},"children":[]}]}]}],"required":["principalOrn","resourceOrn"],"properties":{"principalOrn":{"$ref":"#/components/schemas/user-orn"},"resourceOrn":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-resource-orn","description":"The ORN of the app resource to grant access to","example":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4"},"actor":{"$ref":"#/components/schemas/grant-actor"},"accessDuration":{"$ref":"#/components/schemas/access-duration"},"entitlementData":{"$ref":"#/components/schemas/grant-principal-entitlement-data"}}}},"components/schemas/grant-principal-access-response":{"id":"components/schemas/grant-principal-access-response","kind":"json-schema","title":"grant-principal-access-response","data":{"type":"object","description":"Response for a successful grant principal access request","properties":{"_links":{"type":"object","description":"Links to related resources","properties":{"principalAccess":{"type":"object","description":"Link to retrieve the principal's access","properties":{"href":{"type":"string","format":"uri","description":"The URL to the principal access GET endpoint","example":"https://{myOktaDomain}/governance/api/v1/principal-access?filter=targetPrincipalOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4\" and parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4\""}},"required":["href"]}},"required":["principalAccess"]}},"required":["_links"]}},"components/schemas/revoke-principal-access-creatable":{"id":"components/schemas/revoke-principal-access-creatable","kind":"json-schema","title":"revoke-principal-access-creatable","data":{"type":"object","required":["principalOrn","revokeOrns"],"properties":{"principalOrn":{"$ref":"#/components/schemas/user-orn"},"actor":{"$ref":"#/components/schemas/grant-actor"},"revokeOrns":{"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 "},"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":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" to revoke access:"},"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":"Entitlement value and entitlement bundle resources can be combined in a single request (with a maximum of five resources in a request)."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"App resources must be revoked separately (a request can only contain one app ORN)."},"children":[]}]}]}]}],"minItems":1,"maxItems":5,"items":{"type":"string","description":"ORN of the resource to revoke access (entitlement value, entitlement bundle, or app)","example":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent65J1scEgrRZbjT0g2"}}}}},"components/schemas/revoke-principal-access-resource-links":{"id":"components/schemas/revoke-principal-access-resource-links","kind":"json-schema","title":"revoke-principal-access-resource-links","data":{"description":"Links to related resources for a revoked resource","type":"object","properties":{"_links":{"type":"object","description":"Links to related resources for a revoked-access resource","properties":{"principal-access":{"type":"object","description":"Principal access resources","properties":{"href":{"type":"string","description":"Link to principal access resources","example":"https://myorg.okta.com/governance/api/v1/principal-access?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""}}},"principal-entitlements":{"type":"object","description":"Principal entitlement resources","properties":{"href":{"type":"string","description":"Link to principal entitlements","example":"https://myorg.okta.com/governance/api/v1/principal-entitlements?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""}}}}}}}},"components/schemas/revoke-principal-access-response":{"id":"components/schemas/revoke-principal-access-response","kind":"json-schema","title":"revoke-principal-access-response","data":{"description":"Revoke principal access response","type":"object","properties":{"data":{"type":"array","description":"List of related links for each revoked-access resource","items":{"$ref":"#/components/schemas/revoke-principal-access-resource-links"}}}}},"components/schemas/revoke-external-user-entitlement-creatable":{"id":"components/schemas/revoke-external-user-entitlement-creatable","kind":"json-schema","title":"revoke-external-user-entitlement-creatable","data":{"type":"object","required":["principal","revokeOrns"],"properties":{"principal":{"type":"string","description":"The external/source-system identifier of the unmanaged user whose\nentitlements are being revoked. Provided by the source app at import time.","example":"jdoe@example.com"},"actor":{"$ref":"#/components/schemas/grant-actor"},"revokeOrns":{"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 entitlement-value "},"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":[]}]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"to revoke for this external user"},"children":[]}]}]}],"minItems":1,"maxItems":5,"items":{"type":"string","description":"ORN of the entitlement value to revoke","example":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent65J1scEgrRZbjT0g2"}}}}},"components/schemas/collection-properties-writable":{"id":"components/schemas/collection-properties-writable","kind":"json-schema","title":"collection-properties-writable","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"name":{"type":"string","nullable":false,"description":"The name of a resource collection","maxLength":255,"minLength":1},"description":{"type":"string","nullable":false,"description":"The human-readable description","maxLength":1000,"minLength":1}}}},"components/schemas/okta-collection-orn":{"id":"components/schemas/okta-collection-orn","kind":"json-schema","title":"okta-collection-orn","data":{"type":"string","format":"okta-resource-orn","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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the collection in "},"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 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/collection-counts":{"id":"components/schemas/collection-counts","kind":"json-schema","title":"collection-counts","data":{"type":"object","description":"Collection count metadata","required":["principalAssignmentCount","resourceCounts"],"properties":{"principalAssignmentCount":{"type":"integer","description":"Number of principals assigned","minimum":0,"example":28},"resourceCounts":{"type":"object","description":"Collection resource counts","required":["applications"],"properties":{"applications":{"type":"integer","description":"Number of app resources in a collection","minimum":0,"example":3}}}}}},"components/schemas/collection-links":{"id":"components/schemas/collection-links","kind":"json-schema","title":"collection-links","data":{"type":"object","description":"Links available on a resource collection","required":["resources"],"properties":{"resources":{"$ref":"#/components/schemas/link"}}}},"components/schemas/collection-full":{"id":"components/schemas/collection-full","kind":"json-schema","title":"collection-full","data":{"description":"Full representation of a collection response","allOf":[{"$ref":"#/components/schemas/collection-properties-writable"},{"$ref":"#/components/schemas/read-only-standard-properties"}],"required":["id","name","orn","created","createdBy","lastUpdated","lastUpdatedBy","_links"],"properties":{"orn":{"$ref":"#/components/schemas/okta-collection-orn"},"counts":{"$ref":"#/components/schemas/collection-counts"},"_links":{"$ref":"#/components/schemas/collection-links"}}}},"components/schemas/collections-list":{"id":"components/schemas/collections-list","kind":"json-schema","title":"collections-list","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/collection-full"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/collection-creatable":{"id":"components/schemas/collection-creatable","kind":"json-schema","title":"collection-creatable","data":{"description":"The properties expected when creating a new empty collection","x-okta-ignore-redocly-rules-for-sdk":true,"required":["name"],"allOf":[{"$ref":"#/components/schemas/collection-properties-writable"}]}},"components/schemas/collection-updatable":{"id":"components/schemas/collection-updatable","kind":"json-schema","title":"collection-updatable","data":{"description":"Full representation of a collection to be updated","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/collection-properties-writable"}],"required":["name"]}},"components/schemas/app-resource-orn":{"id":"components/schemas/app-resource-orn","kind":"json-schema","title":"app-resource-orn","data":{"type":"string","format":"okta-resource-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ORN identifier for a specific app. Other resource types aren't supported."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#supported-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported-resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint for reference."},"children":[]}]}]}]}},"components/schemas/collection-resource-properties-writable":{"id":"components/schemas/collection-resource-properties-writable","kind":"json-schema","title":"collection-resource-properties-writable","data":{"type":"object","properties":{"resourceOrn":{"$ref":"#/components/schemas/app-resource-orn"}}}},"components/schemas/collection-resource-links":{"id":"components/schemas/collection-resource-links","kind":"json-schema","title":"collection-resource-links","data":{"type":"object","description":"Links available on a resource within a resource collection","required":["entitlements"],"properties":{"entitlements":{"$ref":"#/components/schemas/link"}}}},"components/schemas/collection-resource-properties-read-only":{"id":"components/schemas/collection-resource-properties-read-only","kind":"json-schema","title":"collection-resource-properties-read-only","data":{"type":"object","properties":{"resourceId":{"$ref":"#/components/schemas/resource-id"},"_links":{"$ref":"#/components/schemas/collection-resource-links"}}}},"components/schemas/resource-profile":{"id":"components/schemas/resource-profile","kind":"json-schema","title":"resource-profile","data":{"type":"object","description":"A limited set of properties from the resource's profile","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta application instance "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":20,"maxLength":20},"name":{"type":"string","description":"The name of the Okta app","minLength":1,"maxLength":255},"label":{"type":"string","description":"The label of the Okta app","minLength":1,"maxLength":255},"logo":{"type":"array","description":"List of app logo resources","items":{"$ref":"#/components/schemas/link"}}}}},"components/schemas/collection-resource-entitlement-value-count":{"id":"components/schemas/collection-resource-entitlement-value-count","kind":"json-schema","title":"collection-resource-entitlement-value-count","data":{"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 entitlements associated with this resource in the collection. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to return this count in the response."},"children":[]}]}]}],"minimum":0}},"components/schemas/collection-resource-full":{"id":"components/schemas/collection-resource-full","kind":"json-schema","title":"collection-resource-full","data":{"description":"Full representation of a resource within a resource collection","allOf":[{"$ref":"#/components/schemas/collection-resource-properties-writable"},{"$ref":"#/components/schemas/collection-resource-properties-read-only"}],"required":["resourceOrn","_links"],"properties":{"resourceProfile":{"$ref":"#/components/schemas/resource-profile"},"entitlements":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The entitlements associated with the collection. Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" query parameter to return entitlements for the collection."},"children":[]}]}]}],"$ref":"#/components/schemas/entitlements-full"},"entitlementValueCount":{"$ref":"#/components/schemas/collection-resource-entitlement-value-count"}}}},"components/schemas/collection-resources-list":{"id":"components/schemas/collection-resources-list","kind":"json-schema","title":"collection-resources-list","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/collection-resource-full"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/collection-resource-creatable":{"id":"components/schemas/collection-resource-creatable","kind":"json-schema","title":"collection-resource-creatable","data":{"description":"The properties expected when adding a new resource to a collection","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/collection-resource-properties-writable"}],"required":["resourceOrn"],"properties":{"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"}}}},"components/schemas/collection-resource-updatable":{"id":"components/schemas/collection-resource-updatable","kind":"json-schema","title":"collection-resource-updatable","data":{"description":"the updatable properties of a collection resource","properties":{"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"}}}},"components/schemas/principal-profile":{"id":"components/schemas/principal-profile","kind":"json-schema","title":"principal-profile","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"A limited set of properties from the principal's profile","required":["id","email","status"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta user "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":1,"maxLength":20},"email":{"type":"string","description":"The Okta user's email address","minLength":1,"maxLength":100},"firstName":{"type":"string","description":"The Okta user's first name","minLength":0,"maxLength":50},"lastName":{"type":"string","description":"The Okta user's last name","minLength":0,"maxLength":50},"login":{"type":"string","description":"The Okta user's sign-in credentials, which is often their email address","minLength":1,"maxLength":100},"status":{"$ref":"#/components/schemas/principal-profile-status"}}}},"components/schemas/self-link":{"id":"components/schemas/self-link","kind":"json-schema","title":"self-link","data":{"type":"object","description":"Links available for an object","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/list-catalog-users":{"id":"components/schemas/list-catalog-users","kind":"json-schema","title":"list-catalog-users","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/principal-profile"}},"_links":{"$ref":"#/components/schemas/self-link"}}}},"components/schemas/assigned-principal":{"id":"components/schemas/assigned-principal","kind":"json-schema","title":"assigned-principal","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/assignment-properties"},{"type":"object","properties":{"principal":{"$ref":"#/components/schemas/target-principal-full"},"actor":{"$ref":"#/components/schemas/grant-actor"},"collectionId":{"$ref":"#/components/schemas/collection-id"}}}]}},"components/schemas/principal-assignment-type":{"id":"components/schemas/principal-assignment-type","kind":"json-schema","title":"principal-assignment-type","data":{"type":"string","description":"Collection assignment type or source","default":"INDIVIDUAL","enum":["INDIVIDUAL"]}},"components/schemas/assigned-principal-full":{"id":"components/schemas/assigned-principal-full","kind":"json-schema","title":"assigned-principal-full","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/assigned-principal"},{"type":"object","properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The assignment "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"maxLength":20,"minLength":20},"assignmentType":{"$ref":"#/components/schemas/principal-assignment-type"}}}]}},"components/schemas/assigned-principal-details":{"id":"components/schemas/assigned-principal-details","kind":"json-schema","title":"assigned-principal-details","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/assigned-principal-full"},{"type":"object","properties":{"principalProfile":{"$ref":"#/components/schemas/principal-profile"}}}]}},"components/schemas/pagination-links":{"id":"components/schemas/pagination-links","kind":"json-schema","title":"pagination-links","data":{"type":"object","description":"Links available in principal assignments list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/list-assigned-principals":{"id":"components/schemas/list-assigned-principals","kind":"json-schema","title":"list-assigned-principals","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/assigned-principal-details"}},"_links":{"$ref":"#/components/schemas/pagination-links"}}}},"components/schemas/add-principals-to-collection":{"id":"components/schemas/add-principals-to-collection","kind":"json-schema","title":"add-principals-to-collection","data":{"description":"list of principals that should be assigned to collection","type":"array","minItems":1,"maxItems":20,"items":{"$ref":"#/components/schemas/assigned-principal"}}},"components/schemas/assignment-patch-op":{"id":"components/schemas/assignment-patch-op","kind":"json-schema","title":"assignment-patch-op","data":{"type":"string","description":"The operation performed for the update","enum":["ADD","REMOVE","REPLACE"],"minLength":1}},"components/schemas/assignment-patch-operation":{"id":"components/schemas/assignment-patch-operation","kind":"json-schema","title":"assignment-patch-operation","data":{"description":"The properties expected in an update collection assignment.","required":["op","path"],"properties":{"op":{"$ref":"#/components/schemas/assignment-patch-op"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path of the property that's updated. For example, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/expirationTime"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/timeZone"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the assignment update."},"children":[]}]}]}]},"value":{"type":"string","description":"The value of the property that's updated"}}}},"components/schemas/assignment-patch":{"id":"components/schemas/assignment-patch","kind":"json-schema","title":"assignment-patch","data":{"description":"Patch properties expected in collection assignment","type":"array","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/assignment-patch-operation"}}},"components/schemas/collection-counts-v2":{"id":"components/schemas/collection-counts-v2","kind":"json-schema","title":"collection-counts-v2","data":{"type":"object","description":"Collection count metadata","required":["principalAssignmentCount","resourceCount"],"properties":{"principalAssignmentCount":{"type":"integer","description":"Number of principals assigned","minimum":0,"example":28},"resourceCount":{"type":"integer","description":"The total number of resources in this collection, across all resource types (apps, groups, and push groups).","minimum":0,"example":5}}}},"components/schemas/collection-full-v2":{"id":"components/schemas/collection-full-v2","kind":"json-schema","title":"collection-full-v2","data":{"description":"Full representation of a collection response (v2)","allOf":[{"$ref":"#/components/schemas/collection-properties-writable"},{"$ref":"#/components/schemas/read-only-standard-properties"},{"type":"object","required":["id","name","orn","created","createdBy","lastUpdated","lastUpdatedBy","_links"],"properties":{"orn":{"$ref":"#/components/schemas/okta-collection-orn"},"counts":{"$ref":"#/components/schemas/collection-counts-v2"},"_links":{"$ref":"#/components/schemas/collection-links"}}}]}},"components/schemas/collection-resource-relationship":{"id":"components/schemas/collection-resource-relationship","kind":"json-schema","title":"collection-resource-relationship","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resource relationship details. Only present when filtering by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"resourceOrn":{"type":"string","description":"The ORN of the resource in this collection","example":"orn:okta:idp:00o1234567890:apps:0oa1234567890"},"addedToCollectionDate":{"type":"string","format":"date-time","description":"When the resource was added to this collection","example":"2024-06-01T12:00:00Z"}}}},"components/schemas/collection-principal-assignment":{"id":"components/schemas/collection-principal-assignment","kind":"json-schema","title":"collection-principal-assignment","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Principal assignment details. Only present when filtering by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"properties":{"principalOrn":{"type":"string","description":"The ORN of the assigned principal","example":"orn:okta:idp:00o1234567890:users:00u1234567890"},"actor":{"type":"string","description":"How the assignment was made","enum":["ACCESS_REQUEST","ADMIN"],"example":"ADMIN"},"assignmentType":{"type":"string","description":"Type of assignment","enum":["INDIVIDUAL"],"example":"INDIVIDUAL"},"expirationTime":{"type":"string","format":"date-time","description":"When the assignment expires (null for indefinite)","nullable":true,"example":"2025-12-31T23:59:59Z"}}}},"components/schemas/collection-full-with-filter-context-v2":{"id":"components/schemas/collection-full-with-filter-context-v2","kind":"json-schema","title":"collection-full-with-filter-context-v2","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A collection with filter-context fields, populated only on LIST responses when filtering by "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/collection-full-v2"},{"type":"object","properties":{"resourceRelationship":{"$ref":"#/components/schemas/collection-resource-relationship"},"principalAssignment":{"$ref":"#/components/schemas/collection-principal-assignment"}}}]}},"components/schemas/collections-list-v2":{"id":"components/schemas/collections-list-v2","kind":"json-schema","title":"collections-list-v2","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/collection-full-with-filter-context-v2"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/collection-resource-orn":{"id":"components/schemas/collection-resource-orn","kind":"json-schema","title":"collection-resource-orn","data":{"type":"string","format":"okta-resource-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The ORN identifier for a collection resource (app, group, or push group)."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"See the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/api/openapi/okta-management/guides/roles/#supported-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported-resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" endpoint."},"children":[]}]}]}]}},"components/schemas/collection-resource-properties-writable-v2":{"id":"components/schemas/collection-resource-properties-writable-v2","kind":"json-schema","title":"collection-resource-properties-writable-v2","data":{"type":"object","properties":{"resourceOrn":{"$ref":"#/components/schemas/collection-resource-orn"}}}},"components/schemas/collection-resource-id":{"id":"components/schemas/collection-resource-id","kind":"json-schema","title":"collection-resource-id","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"format":"okta-resource-id","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The unique resource ID for this resource (app, group, or push group). Use this identifier to reference the resource in collection-resource API calls, such as "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GET"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"PUT"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"/"},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"DELETE /v2/collections/{collectionId}/resources/{resourceId}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"maxLength":20}},"components/schemas/collection-resource-links-v2":{"id":"components/schemas/collection-resource-links-v2","kind":"json-schema","title":"collection-resource-links-v2","data":{"type":"object","description":"Links available on a resource within a resource collection","required":["resource"],"properties":{"resource":{"$ref":"#/components/schemas/link"},"entitlements":{"description":"Link to the entitlements endpoint for this resource in this collection. Only present for apps that are Entitlement Management enabled.","$ref":"#/components/schemas/link"}}}},"components/schemas/collection-resource-properties-read-only-v2":{"id":"components/schemas/collection-resource-properties-read-only-v2","kind":"json-schema","title":"collection-resource-properties-read-only-v2","data":{"type":"object","properties":{"resourceId":{"$ref":"#/components/schemas/collection-resource-id"},"_links":{"$ref":"#/components/schemas/collection-resource-links-v2"}}}},"components/schemas/resource-profile-v2":{"id":"components/schemas/resource-profile-v2","kind":"json-schema","title":"resource-profile-v2","data":{"type":"object","description":"A limited set of properties from the resource's profile","properties":{"id":{"type":"string","description":"Okta resource instance ID","minLength":20,"maxLength":20},"name":{"type":"string","description":"The name of the Okta resource","minLength":1,"maxLength":255},"label":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The label of the Okta app. Only populated for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"APPLICATION"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type resources."},"children":[]}]}]}],"minLength":1,"maxLength":255},"description":{"type":"string","description":"The description of the resource"},"logo":{"type":"array","description":"List of resource logo resources","items":{"$ref":"#/components/schemas/link"}}}}},"components/schemas/collection-resource-counts":{"id":"components/schemas/collection-resource-counts","kind":"json-schema","title":"collection-resource-counts","data":{"type":"object","description":"Counts of related items for this resource. Only non-zero counts are included.","properties":{"entitlements":{"type":"integer","description":"The total number of entitlements included for this app resource in this collection","minimum":0},"pushGroups":{"type":"integer","description":"The total number of push groups associated with this app resource in this collection","minimum":0},"labels":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of governance labels associated with this resource. Only returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified. Not supported in LIST calls."},"children":[]}]}]}],"minimum":0},"relatedApps":{"type":"integer","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The total number of related apps for this resource. Only returned when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"include=relatedApps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is specified. Not supported in LIST calls."},"children":[]}]}]}],"minimum":0}}}},"components/schemas/collection-resource-configuration":{"id":"components/schemas/collection-resource-configuration","kind":"json-schema","title":"collection-resource-configuration","data":{"type":"object","description":"Server-resolved configuration details for this resource within the collection","readOnly":true,"required":["entitlementManagementEnabled","type"],"properties":{"entitlementManagementEnabled":{"type":"boolean","description":"Indicates whether Entitlement Management is enabled for this resource"},"hasPushMapping":{"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 this group resource has push group mappings to applications (is a push group). Only present 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":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"type":{"type":"string","description":"The type of resource","enum":["APPLICATION","GROUP"]},"counts":{"$ref":"#/components/schemas/collection-resource-counts"}}}},"components/schemas/push-group-id":{"id":"components/schemas/push-group-id","kind":"json-schema","title":"push-group-id","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Unique Okta Group ID for the push group","example":"00go3v6xlwdtEX2il1d6","minLength":20,"maxLength":20}},"components/schemas/push-group-name":{"id":"components/schemas/push-group-name","kind":"json-schema","title":"push-group-name","data":{"type":"string","description":"The name of the push group","minLength":1,"maxLength":255}},"components/schemas/push-group-description":{"id":"components/schemas/push-group-description","kind":"json-schema","title":"push-group-description","data":{"type":"string","description":"The description of the push group"}},"components/schemas/push-group-full":{"id":"components/schemas/push-group-full","kind":"json-schema","title":"push-group-full","data":{"type":"object","description":"Full representation of a push group","properties":{"id":{"$ref":"#/components/schemas/push-group-id"},"name":{"$ref":"#/components/schemas/push-group-name"},"description":{"$ref":"#/components/schemas/push-group-description"},"logo":{"type":"array","description":"List of push group logo resources","items":{"$ref":"#/components/schemas/link"}}}}},"components/schemas/collection-push-group":{"id":"components/schemas/collection-push-group","kind":"json-schema","title":"collection-push-group","data":{"description":"A push group represented as a resource in a collection","allOf":[{"$ref":"#/components/schemas/push-group-full"},{"type":"object","required":["resourceId","resourceOrn"],"properties":{"resourceId":{"$ref":"#/components/schemas/collection-resource-id"},"resourceOrn":{"$ref":"#/components/schemas/collection-resource-orn"}}}]}},"components/schemas/collection-push-groups":{"id":"components/schemas/collection-push-groups","kind":"json-schema","title":"collection-push-groups","data":{"type":"array","description":"List of push groups associated with an app collection resource","nullable":false,"items":{"$ref":"#/components/schemas/collection-push-group"}}},"components/schemas/governance-labels":{"id":"components/schemas/governance-labels","kind":"json-schema","title":"governance-labels","data":{"type":"array","description":"The governance labels associated with this resource","nullable":false,"items":{"$ref":"#/components/schemas/label-value"}}},"components/schemas/related-app":{"id":"components/schemas/related-app","kind":"json-schema","title":"related-app","data":{"description":"An app that's related to this resource","allOf":[{"$ref":"#/components/schemas/resource-profile-v2"},{"type":"object","properties":{"inCollection":{"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 this app is also a resource in the current collection. Only present for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type resources."},"children":[]}]}]}]}}}]}},"components/schemas/related-apps":{"id":"components/schemas/related-apps","kind":"json-schema","title":"related-apps","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The apps related to this resource. Only populated for "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" type resources. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasPushMapping: true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", these are apps that this group is mapped to through push group. For "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"GROUP"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" resources with "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"hasPushMapping: false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", these are apps assigned to this group."},"children":[]}]}]}],"nullable":false,"items":{"$ref":"#/components/schemas/related-app"}}},"components/schemas/collection-resource-full-v2":{"id":"components/schemas/collection-resource-full-v2","kind":"json-schema","title":"collection-resource-full-v2","data":{"description":"Full representation of a resource within a resource collection","allOf":[{"$ref":"#/components/schemas/collection-resource-properties-writable-v2"},{"$ref":"#/components/schemas/collection-resource-properties-read-only-v2"}],"required":["resourceOrn","_links"],"properties":{"resourceProfile":{"$ref":"#/components/schemas/resource-profile-v2"},"resourceConfiguration":{"$ref":"#/components/schemas/collection-resource-configuration"},"entitlements":{"$ref":"#/components/schemas/entitlements-full"},"pushGroups":{"$ref":"#/components/schemas/collection-push-groups"},"labels":{"$ref":"#/components/schemas/governance-labels"},"relatedApps":{"$ref":"#/components/schemas/related-apps"}}}},"components/schemas/collection-resources-list-v2":{"id":"components/schemas/collection-resources-list-v2","kind":"json-schema","title":"collection-resources-list-v2","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/collection-resource-full-v2"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/collection-resource-creatable-v2":{"id":"components/schemas/collection-resource-creatable-v2","kind":"json-schema","title":"collection-resource-creatable-v2","data":{"description":"The properties expected when adding a new resource to a collection","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/collection-resource-properties-writable-v2"}],"required":["resourceOrn"],"properties":{"entitlements":{"$ref":"#/components/schemas/entitlements-creatable"}}}},"components/schemas/collection-resource-app-with-entitlements":{"id":"components/schemas/collection-resource-app-with-entitlements","kind":"json-schema","title":"collection-resource-app-with-entitlements","data":{"description":"Representation of an EM-enabled app resource after updating entitlements","allOf":[{"$ref":"#/components/schemas/collection-resource-properties-writable-v2"},{"$ref":"#/components/schemas/collection-resource-properties-read-only-v2"}],"required":["resourceOrn","_links"],"properties":{"resourceConfiguration":{"$ref":"#/components/schemas/collection-resource-configuration"},"entitlements":{"$ref":"#/components/schemas/entitlements-full"}}}},"components/schemas/collection-resource-entitlements-list":{"id":"components/schemas/collection-resource-entitlements-list","kind":"json-schema","title":"collection-resource-entitlements-list","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/entitlement-full"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/criteria-value":{"id":"components/schemas/criteria-value","kind":"json-schema","title":"criteria-value","data":{"type":"object","description":"Criteria value","properties":{"type":{"type":"string","nullable":false,"description":"Criteria value type","enum":["ENTITLEMENTS"]},"value":{"$ref":"#/components/schemas/entitlements-full"}}}},"components/schemas/criteria":{"id":"components/schemas/criteria","kind":"json-schema","title":"criteria","data":{"type":"object","properties":{"name":{"type":"string","nullable":false,"description":"Name of the criteria"},"attribute":{"type":"string","nullable":false,"description":"Attribute that the criteria applies to"},"operation":{"type":"string","nullable":false,"description":"Operation performed on the criteria value","enum":["CONTAINS_ONE","CONTAINS_ALL"]},"value":{"$ref":"#/components/schemas/criteria-value"}}}},"components/schemas/conflict-criteria":{"id":"components/schemas/conflict-criteria","kind":"json-schema","title":"conflict-criteria","data":{"type":"object","description":"Conflict criteria for the risk rule","properties":{"and":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A conflict occurs when two criteria evaluate to true in a logical "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" evaluation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria are evaluated in order, and the first criterion that evaluates to false causes the entire "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" evaluation to be false."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both criteria evaluate to true, then a conflict is detected."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/criteria"},"minItems":2,"maxItems":2}}}},"components/schemas/rule-conflict-common":{"id":"components/schemas/rule-conflict-common","kind":"json-schema","title":"rule-conflict-common","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"id":{"description":"Unique identifier for the object","type":"string","minLength":1},"description":{"type":"string","nullable":false,"description":"Description for the risk rule","maxLength":1000,"minLength":1},"type":{"type":"string","nullable":false,"description":"Risk rule type","enum":["SEPARATION_OF_DUTIES"]},"conflictCriteria":{"$ref":"#/components/schemas/conflict-criteria"}}}},"components/schemas/rule-conflict-resource":{"id":"components/schemas/rule-conflict-resource","kind":"json-schema","title":"rule-conflict-resource","data":{"type":"object","properties":{"resourceOrn":{"$ref":"#/components/schemas/resource-orn"}}}},"components/schemas/risk-rule-conflict":{"id":"components/schemas/risk-rule-conflict","kind":"json-schema","title":"risk-rule-conflict","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/rule-conflict-common"},{"$ref":"#/components/schemas/read-only-standard-properties"},{"type":"object","properties":{"name":{"type":"string","nullable":false,"description":"Name of the resource risk rule","maxLength":255,"minLength":1},"notes":{"type":"string","description":"Additional information about the risk rule","maxLength":1000,"minLength":1},"resources":{"type":"array","description":"Resources that the risk rule applies to","maxItems":1,"items":{"$ref":"#/components/schemas/rule-conflict-resource"}},"status":{"type":"string","nullable":false,"description":"Status of the risk rule","enum":["ACTIVE","INVALID"]}}}]}},"components/schemas/risk-rule-response":{"id":"components/schemas/risk-rule-response","kind":"json-schema","title":"risk-rule-response","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","name","type","status","resources","conflictCriteria","_links"],"allOf":[{"$ref":"#/components/schemas/risk-rule-conflict"}],"properties":{"_links":{"$ref":"#/components/schemas/link-self"}}}},"components/schemas/list-risk-rule-response":{"id":"components/schemas/list-risk-rule-response","kind":"json-schema","title":"list-risk-rule-response","data":{"type":"object","properties":{"data":{"description":"All risk rules on the current page","type":"array","items":{"$ref":"#/components/schemas/risk-rule-response"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/criteria-value-creatable":{"id":"components/schemas/criteria-value-creatable","kind":"json-schema","title":"criteria-value-creatable","data":{"type":"object","description":"Criteria value","properties":{"type":{"type":"string","nullable":false,"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 criteria value. Supported type: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ENTITLEMENTS"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"enum":["ENTITLEMENTS"]},"value":{"$ref":"#/components/schemas/entitlements-creatable"}}}},"components/schemas/criteria-creatable":{"id":"components/schemas/criteria-creatable","kind":"json-schema","title":"criteria-creatable","data":{"type":"object","properties":{"name":{"type":"string","nullable":false,"description":"Name of the criteria"},"attribute":{"type":"string","nullable":false,"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Attribute that the criteria applies to. Supported attribute: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"principal.effective_grants"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"operation":{"type":"string","nullable":false,"description":"Operation performed on the criteria value","enum":["CONTAINS_ONE","CONTAINS_ALL"]},"value":{"$ref":"#/components/schemas/criteria-value-creatable"}}}},"components/schemas/conflict-criteria-creatable":{"id":"components/schemas/conflict-criteria-creatable","kind":"json-schema","title":"conflict-criteria-creatable","data":{"type":"object","description":"Conflict criteria for the risk rule","properties":{"and":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A conflict occurs when two criteria evaluate to true in a logical "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" evaluation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria are evaluated in order, and the first criterion that evaluates to false causes the entire "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" evaluation to be false."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both criteria evaluate to true, then a conflict is detected."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/criteria-creatable"},"minItems":2,"maxItems":2}}}},"components/schemas/rule-conflict-creatable":{"id":"components/schemas/rule-conflict-creatable","kind":"json-schema","title":"rule-conflict-creatable","data":{"type":"object","properties":{"name":{"type":"string","nullable":false,"description":"Name of the resource risk rule","maxLength":255,"minLength":1},"description":{"type":"string","nullable":false,"description":"Description of the risk rule","maxLength":1000,"minLength":1},"notes":{"type":"string","description":"Additional information about the risk rule","maxLength":1000,"minLength":1},"type":{"type":"string","nullable":false,"description":"Risk rule type","enum":["SEPARATION_OF_DUTIES"]},"resources":{"type":"array","description":"Resources that the risk rule applies to","maxItems":1,"items":{"$ref":"#/components/schemas/rule-conflict-resource"}},"conflictCriteria":{"$ref":"#/components/schemas/conflict-criteria-creatable"}}}},"components/schemas/create-risk-rule-request":{"id":"components/schemas/create-risk-rule-request","kind":"json-schema","title":"create-risk-rule-request","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["name","type","resources","conflictCriteria"],"allOf":[{"$ref":"#/components/schemas/rule-conflict-creatable"}]}},"components/schemas/conflict-criteria-updatable":{"id":"components/schemas/conflict-criteria-updatable","kind":"json-schema","title":"conflict-criteria-updatable","data":{"type":"object","description":"Conflict criteria for the risk rule","nullable":true,"properties":{"and":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A conflict occurs when two criteria evaluate to true in a logical "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" evaluation."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The criteria are evaluated in order, and the first criterion that evaluates to false causes the entire "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"AND"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" evaluation to be false."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If both criteria evaluate to true, then a conflict is detected."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/criteria-creatable"},"minItems":2,"maxItems":2}}}},"components/schemas/update-risk-rule-request":{"id":"components/schemas/update-risk-rule-request","kind":"json-schema","title":"update-risk-rule-request","data":{"type":"object","required":["id"],"properties":{"id":{"description":"Unique identifier for the object","type":"string","minLength":1},"name":{"type":"string","nullable":true,"description":"Name of the resource risk rule","maxLength":255,"minLength":1},"notes":{"type":"string","nullable":true,"description":"Additional information about the rule","maxLength":1000},"description":{"type":"string","nullable":true,"description":"Description of the risk rule","maxLength":1000},"conflictCriteria":{"$ref":"#/components/schemas/conflict-criteria-updatable"}}}},"components/schemas/okta-resource-orn":{"id":"components/schemas/okta-resource-orn","kind":"json-schema","title":"okta-resource-orn","data":{"type":"string","format":"okta-resource-orn","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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the resource in "},"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":" format. The resource can be a collection, a bundle, or an entitlement."},"children":[]}]}]}]}},"components/schemas/potential-risk-assessment-request":{"id":"components/schemas/potential-risk-assessment-request","kind":"json-schema","title":"potential-risk-assessment-request","data":{"type":"object","required":["principalOrn"],"properties":{"principalOrn":{"$ref":"#/components/schemas/user-orn"},"resourceOrnList":{"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 resources in ORN format. The resource can be a collection, a bundle, or an entitlement."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The list must contain the same resource type. The maximum items in the list depends on the resource 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":"text","inline":true,"attributes":{"content":"Maximum list size for a collection is 1."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum list size for a bundle is 1."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Maximum list size for entitlements is 20."},"children":[]}]}]}]}],"maxItems":20,"minItems":1,"items":{"$ref":"#/components/schemas/okta-resource-orn"}},"resourceOrn":{"$ref":"#/components/schemas/okta-resource-orn"}}}},"components/schemas/rule-conflict":{"id":"components/schemas/rule-conflict","kind":"json-schema","title":"rule-conflict","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/rule-conflict-common"}],"properties":{"principalOrn":{"$ref":"#/components/schemas/user-orn"},"resourceOrn":{"$ref":"#/components/schemas/resource-orn"},"ruleId":{"description":"Unique identifier for the rule object","type":"string","minLength":1},"ruleName":{"type":"string","nullable":false,"description":"The name of the resource rule causing the conflict","maxLength":255,"minLength":1}}}},"components/schemas/risk-assessment-links":{"id":"components/schemas/risk-assessment-links","kind":"json-schema","title":"risk-assessment-links","data":{"type":"object","description":"Links available in risk assessment list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/risk-assessment-response":{"id":"components/schemas/risk-assessment-response","kind":"json-schema","title":"risk-assessment-response","data":{"type":"object","required":["data","_links"],"properties":{"data":{"description":"List of conflicts for the requested resource","type":"array","maxItems":200,"items":{"$ref":"#/components/schemas/rule-conflict"}},"_links":{"$ref":"#/components/schemas/risk-assessment-links"}}}},"components/schemas/resource-owner-principal-orn":{"id":"components/schemas/resource-owner-principal-orn","kind":"json-schema","title":"resource-owner-principal-orn","data":{"type":"string","format":"okta-principal-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta user or group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"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":" format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource can be an user id, or a group id."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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/openapi/okta-management/guides/roles/#supported-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supported resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/external-principal-profile":{"id":"components/schemas/external-principal-profile","kind":"json-schema","title":"external-principal-profile","data":{"type":"object","description":"A limited set of properties from the principal's profile","required":["id","name","_links"],"properties":{"id":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta user "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or Okta group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]}]}]}],"minLength":20,"maxLength":20},"name":{"type":"string","description":"User name or group name","minLength":1,"maxLength":255},"email":{"type":"string","description":"Email of the resource owner, if applicable","minLength":1,"maxLength":255},"metadata":{"type":"object","description":"Additional metadata about the resource owner, if applicable","properties":{"userAssignmentCount":{"type":"integer","description":"Total number of users assigned to the group"}}},"logo":{"type":"array","description":"List of logo resources","items":{"$ref":"#/components/schemas/link"}},"_links":{"$ref":"#/components/schemas/link-self"}}}},"components/schemas/resource-owner-principal":{"id":"components/schemas/resource-owner-principal","kind":"json-schema","title":"resource-owner-principal","data":{"type":"object","description":"Details of the principal, which can be a user or a group, that is an owner of a resource","required":["id","type","orn","profile"],"properties":{"id":{"type":"string","description":"A unique identifier for the principal in Okta","minLength":20,"maxLength":20},"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 principal type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{objectType}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute from 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":" string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"groups"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"users"},"children":[]}]}]}]},"orn":{"$ref":"#/components/schemas/resource-owner-principal-orn"},"profile":{"$ref":"#/components/schemas/external-principal-profile"}}}},"components/schemas/resource-owner-resource-orn":{"id":"components/schemas/resource-owner-resource-orn","kind":"json-schema","title":"resource-owner-resource-orn","data":{"type":"string","format":"okta-resource-orn","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 resource in "},"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":" format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource can be an app, an entitlement value, an entitlement bundle, a collection, or an AI agent."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"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/openapi/okta-management/guides/roles/#supported-resources"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"supported resources"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]}},"components/schemas/external-resource-profile-parent":{"id":"components/schemas/external-resource-profile-parent","kind":"json-schema","title":"external-resource-profile-parent","data":{"type":"object","description":"A limited set of properties from the resource's parent profile","required":["id"],"properties":{"id":{"type":"string","description":"Okta resource ID","minLength":20,"maxLength":20},"name":{"type":"string","description":"The display name for the resource","minLength":1,"maxLength":255}}}},"components/schemas/external-resource-profile":{"id":"components/schemas/external-resource-profile","kind":"json-schema","title":"external-resource-profile","data":{"type":"object","description":"A limited set of properties from the resource's profile","required":["id","name"],"properties":{"id":{"type":"string","description":"Okta resource ID","minLength":20,"maxLength":20},"name":{"type":"string","description":"The display name for the resource","minLength":1,"maxLength":255},"description":{"type":"string","description":"The description of the resource","minLength":1,"maxLength":1000},"parent":{"$ref":"#/components/schemas/external-resource-profile-parent"},"label":{"type":"string","description":"The label of the Okta resource","minLength":1,"maxLength":255},"logo":{"type":"array","description":"List of logo resources","items":{"$ref":"#/components/schemas/link"}}}}},"components/schemas/resource-owner-resource":{"id":"components/schemas/resource-owner-resource","kind":"json-schema","title":"resource-owner-resource","data":{"type":"object","description":"Details of a resource that are owned by the principal, such as an app, an entitlement value, an entitlement bundle, a collection, or an AI agent","required":["id","type","orn","profile"],"properties":{"id":{"type":"string","format":"okta-resource-id","description":"A unique identifier for the resource in Okta","minLength":20,"maxLength":20},"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 resource type."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This value is the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"{objectType}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" attribute from 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":" string."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Examples: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"apps"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlement-bundles"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"entitlement-values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"collections"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ai-agents"},"children":[]}]}]}]},"orn":{"$ref":"#/components/schemas/resource-owner-resource-orn"},"profile":{"$ref":"#/components/schemas/external-resource-profile"}}}},"components/schemas/resource-owner":{"id":"components/schemas/resource-owner","kind":"json-schema","title":"resource-owner","data":{"type":"object","required":["resource"],"properties":{"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"principals":{"minItems":0,"maxItems":5,"type":"array","description":"The principals that own the resource (users or groups)","items":{"$ref":"#/components/schemas/resource-owner-principal"}},"resource":{"$ref":"#/components/schemas/resource-owner-resource"}}}},"components/schemas/resource-owners-list-links":{"id":"components/schemas/resource-owners-list-links","kind":"json-schema","title":"resource-owners-list-links","data":{"type":"object","description":"Related links available in a list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/resource-owners-list-response":{"id":"components/schemas/resource-owners-list-response","kind":"json-schema","title":"resource-owners-list-response","data":{"type":"object","properties":{"data":{"description":"Resource owner details.","type":"array","items":{"$ref":"#/components/schemas/resource-owner"}},"_links":{"$ref":"#/components/schemas/resource-owners-list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/resource-owners-updatable":{"id":"components/schemas/resource-owners-updatable","kind":"json-schema","title":"resource-owners-updatable","data":{"description":"The properties expected in create or update request for a resource owner.","required":["resourceOrns"],"properties":{"principalOrns":{"type":"array","description":"Owners of the resource. If no owners are provided (empty list), then all current owners are removed.","minItems":0,"maxItems":5,"items":{"$ref":"#/components/schemas/resource-owner-principal-orn"}},"resourceOrns":{"type":"array","description":"The resources to assign owners","minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/resource-owner-resource-orn"}}}}},"components/schemas/resource-owners-response":{"id":"components/schemas/resource-owners-response","kind":"json-schema","title":"resource-owners-response","data":{"type":"object","properties":{"data":{"description":"Resource owner details","type":"array","items":{"$ref":"#/components/schemas/resource-owner"}}}}},"components/schemas/resource-owners-patch":{"id":"components/schemas/resource-owners-patch","kind":"json-schema","title":"resource-owners-patch","data":{"type":"object","required":["resourceOrn","data"],"properties":{"resourceOrn":{"$ref":"#/components/schemas/resource-owner-resource-orn"},"data":{"minItems":1,"maxItems":5,"items":{"type":"object","properties":{"op":{"type":"string","description":"The operation to be performed for update.","enum":["REMOVE"]},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path of the property being updated. Only "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/principalOrn"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" can be updated."},"children":[]}]}]}]},"value":{"$ref":"#/components/schemas/resource-owner-principal-orn"}}}}}}},"components/schemas/resource-owners-catalog-resources-response":{"id":"components/schemas/resource-owners-catalog-resources-response","kind":"json-schema","title":"resource-owners-catalog-resources-response","data":{"type":"object","required":["parentResourceOrn","_links"],"properties":{"parentResourceOrn":{"$ref":"#/components/schemas/resource-orn"},"data":{"description":"Resource owner details","type":"array","items":{"$ref":"#/components/schemas/resource-owner-resource"}},"_links":{"$ref":"#/components/schemas/resource-owners-list-links"}}}},"components/schemas/list-labels":{"id":"components/schemas/list-labels","kind":"json-schema","title":"list-labels","data":{"type":"object","properties":{"data":{"description":"All labels on the current page","type":"array","items":{"$ref":"#/components/schemas/label"}},"_links":{"$ref":"#/components/schemas/list-links"}},"required":["data","_links"]}},"components/schemas/label-value-create":{"id":"components/schemas/label-value-create","kind":"json-schema","title":"label-value-create","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"name":{"type":"string","description":"The label value","minLength":1,"maxLength":50},"metadata":{"$ref":"#/components/schemas/label-metadata"}},"required":["name"]}},"components/schemas/label-create":{"id":"components/schemas/label-create","kind":"json-schema","title":"label-create","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"name":{"type":"string","description":"Key name of the label","minLength":1,"maxLength":50},"values":{"type":"array","description":"List of label values","maxItems":10,"items":{"allOf":[{"$ref":"#/components/schemas/label-value-create"}]}}},"required":["name","values"]}},"components/schemas/label-patch-op":{"id":"components/schemas/label-patch-op","kind":"json-schema","title":"label-patch-op","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The operation to perform a label update","enum":["REPLACE"],"minLength":1}},"components/schemas/patch-label-operation":{"id":"components/schemas/patch-label-operation","kind":"json-schema","title":"patch-label-operation","data":{"description":"The properties for updating a label","required":["op","path","refType"],"properties":{"op":{"$ref":"#/components/schemas/label-patch-op"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path of the property to update."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" path to update the label category name."},"children":[]}]}]}]},"value":{"type":"string","description":"The value of the updated property","maxLength":50},"refType":{"type":"string","description":"The label property for the update operation","enum":["LABEL-CATEGORY"]}}}},"components/schemas/label-value-patch-op":{"id":"components/schemas/label-value-patch-op","kind":"json-schema","title":"label-value-patch-op","data":{"type":"string","description":"The operation to perform a label update","enum":["ADD","REMOVE","REPLACE"],"minLength":1}},"components/schemas/label-value-update":{"id":"components/schemas/label-value-update","kind":"json-schema","title":"label-value-update","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The value of the updated label properties","properties":{"name":{"type":"string","description":"The label value","maxLength":50},"metadata":{"$ref":"#/components/schemas/label-metadata"}}}},"components/schemas/patch-label-value-operation":{"id":"components/schemas/patch-label-value-operation","kind":"json-schema","title":"patch-label-value-operation","data":{"description":"The properties for updating a label value","required":["op","path","refType"],"properties":{"op":{"$ref":"#/components/schemas/label-value-patch-op"},"path":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The path of the property to update."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use the following path format:"},"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":"/values/-"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"ADD"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/values/{id}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REMOVE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"/values/{id}/..."},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" for the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"REPLACE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" operation"},"children":[]}]}]}]}]},"value":{"$ref":"#/components/schemas/label-value-update"},"refType":{"type":"string","description":"The label property for the update operation","enum":["LABEL-VALUE"]}}}},"components/schemas/patch-labels":{"id":"components/schemas/patch-labels","kind":"json-schema","title":"patch-labels","data":{"description":"Patch properties for a label","type":"array","x-okta-ignore-redocly-rules-for-sdk":true,"minItems":1,"maxItems":10,"items":{"type":"object","oneOf":[{"$ref":"#/components/schemas/patch-label-operation"},{"$ref":"#/components/schemas/patch-label-value-operation"}],"discriminator":{"propertyName":"refType","mapping":{"LABEL-CATEGORY":"#/components/schemas/patch-label-operation","LABEL-VALUE":"#/components/schemas/patch-label-value-operation"}}}}},"components/schemas/resource-label":{"id":"components/schemas/resource-label","kind":"json-schema","title":"resource-label","data":{"type":"object","properties":{"orn":{"$ref":"#/components/schemas/resource-orn"},"profile":{"$ref":"#/components/schemas/external-resource-profile"},"labels":{"type":"array","description":"List of assigned labels","maxItems":10,"items":{"$ref":"#/components/schemas/label"}},"_links":{"$ref":"#/components/schemas/link-self"}},"required":["_links"]}},"components/schemas/list-resource-labels":{"id":"components/schemas/list-resource-labels","kind":"json-schema","title":"list-resource-labels","data":{"type":"object","properties":{"data":{"description":"Resources with labels","type":"array","items":{"$ref":"#/components/schemas/resource-label"}},"_links":{"$ref":"#/components/schemas/list-links"}},"required":["data","_links"]}},"components/schemas/resource-label-resource-orn":{"id":"components/schemas/resource-label-resource-orn","kind":"json-schema","title":"resource-label-resource-orn","data":{"type":"string","format":"okta-resource-orn","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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the resource in "},"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":" format."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The resource can be a group, an app, a collection, an entitlement bundle, or an entitlement value."},"children":[]}]}]}]}},"components/schemas/assign-resource-labels":{"id":"components/schemas/assign-resource-labels","kind":"json-schema","title":"assign-resource-labels","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The properties to assign resources to labels. All resources in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrns"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list are assigned to all labels in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labelValueIds"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"  list."},"children":[]}]}]}],"required":["resourceOrns","labelValueIds"],"properties":{"resourceOrns":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Resources assigned to labels (in "},"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":" format)"},"children":[]}]}]}],"minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/resource-label-resource-orn"}},"labelValueIds":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Labels assigned to resources in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceOrns"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" list"},"children":[]}]}]}],"minItems":1,"maxItems":10,"items":{"$ref":"#/components/schemas/label-value-id"}}}}},"components/schemas/assignment-resource-labels-result":{"id":"components/schemas/assignment-resource-labels-result","kind":"json-schema","title":"assignment-resource-labels-result","data":{"type":"object","properties":{"data":{"description":"Resources with labels","type":"array","items":{"$ref":"#/components/schemas/resource-label"}}},"required":["data","_links"]}},"components/schemas/delegate-appointment-delegate":{"id":"components/schemas/delegate-appointment-delegate","kind":"json-schema","title":"delegate-appointment-delegate","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The appointed principal who performs delegated duties\n","allOf":[{"$ref":"#/components/schemas/target-principal"}]}},"components/schemas/delegate-appointment-note":{"id":"components/schemas/delegate-appointment-note","kind":"json-schema","title":"delegate-appointment-note","data":{"type":"string","maxLength":1000,"description":"A note that describes the delegate appointment"}},"components/schemas/delegate-appointment-start-time":{"id":"components/schemas/delegate-appointment-start-time","kind":"json-schema","title":"delegate-appointment-start-time","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The start time of the delegate appointment, in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date and time format"},"children":[]}]}]}]}},"components/schemas/delegate-appointment-end-time":{"id":"components/schemas/delegate-appointment-end-time","kind":"json-schema","title":"delegate-appointment-end-time","data":{"type":"string","format":"date-time","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The time when the delegate appointment expires, in "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://www.rfc-editor.org/rfc/rfc3339.html"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"RFC3339"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" date and time format"},"children":[]}]}]}]}},"components/schemas/delegate-patchable":{"id":"components/schemas/delegate-patchable","kind":"json-schema","title":"delegate-patchable","data":{"type":"object","properties":{"delegate":{"$ref":"#/components/schemas/delegate-appointment-delegate"},"note":{"$ref":"#/components/schemas/delegate-appointment-note"},"startTime":{"$ref":"#/components/schemas/delegate-appointment-start-time"},"endTime":{"$ref":"#/components/schemas/delegate-appointment-end-time"}},"required":["delegate"]}},"components/schemas/delegates-patchable":{"id":"components/schemas/delegates-patchable","kind":"json-schema","title":"delegates-patchable","data":{"type":"object","description":"Delegates for the principal","properties":{"appointments":{"type":"array","description":"Delegate appointments","nullable":true,"maxItems":1,"minItems":0,"items":{"$ref":"#/components/schemas/delegate-patchable"}}}}},"components/schemas/principal-settings-patchable":{"id":"components/schemas/principal-settings-patchable","kind":"json-schema","title":"principal-settings-patchable","data":{"type":"object","description":"Governance settings for a principal\n","properties":{"delegates":{"$ref":"#/components/schemas/delegates-patchable"}}}},"components/schemas/delegate-readonly":{"id":"components/schemas/delegate-readonly","kind":"json-schema","title":"delegate-readonly","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Delegate appointment settings\n","properties":{"id":{"description":"Unique identifier for the delegate appointment","type":"string","minLength":20,"maxLength":20},"delegate":{"$ref":"#/components/schemas/delegate-appointment-delegate"},"startTime":{"$ref":"#/components/schemas/delegate-appointment-start-time"},"endTime":{"$ref":"#/components/schemas/delegate-appointment-end-time"},"note":{"$ref":"#/components/schemas/delegate-appointment-note"},"createdBy":{"$ref":"#/components/schemas/created-by"},"created":{"$ref":"#/components/schemas/created"},"lastUpdated":{"$ref":"#/components/schemas/last-updated"},"lastUpdatedBy":{"$ref":"#/components/schemas/last-updated-by"}},"required":["id","delegate","createdBy","created","lastUpdated","lastUpdatedBy"]}},"components/schemas/delegate-appointment-delegator":{"id":"components/schemas/delegate-appointment-delegator","kind":"json-schema","title":"delegate-appointment-delegator","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The principal who delegated their governance duties\n","allOf":[{"$ref":"#/components/schemas/target-principal"}]}},"components/schemas/delegate-appointment":{"id":"components/schemas/delegate-appointment","kind":"json-schema","title":"delegate-appointment","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Delegate appointment settings\n","allOf":[{"$ref":"#/components/schemas/delegate-readonly"}],"properties":{"delegator":{"$ref":"#/components/schemas/delegate-appointment-delegator"}},"required":["delegator"]}},"components/schemas/principal-settings":{"id":"components/schemas/principal-settings","kind":"json-schema","title":"principal-settings","data":{"type":"object","properties":{"delegates":{"type":"object","description":"Delegates for the principal","properties":{"appointments":{"description":"Delegate appointments","type":"array","maxItems":1,"minItems":0,"items":{"$ref":"#/components/schemas/delegate-appointment"}}}}}}},"components/schemas/delegate-appointment-list-links":{"id":"components/schemas/delegate-appointment-list-links","kind":"json-schema","title":"delegate-appointment-list-links","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Link relations 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":[]}]}]}]}],"required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/delegate-appointment-list":{"id":"components/schemas/delegate-appointment-list","kind":"json-schema","title":"delegate-appointment-list","data":{"type":"object","required":["data","_links"],"properties":{"data":{"description":"Delegate appointments","type":"array","items":{"$ref":"#/components/schemas/delegate-appointment"}},"_links":{"$ref":"#/components/schemas/delegate-appointment-list-links"}}}},"components/schemas/org-settings-permission":{"id":"components/schemas/org-settings-permission","kind":"json-schema","title":"org-settings-permission","data":{"type":"string","description":"Permission that can be assigned to a setting"}},"components/schemas/org-settings-permissions-read-only":{"id":"components/schemas/org-settings-permissions-read-only","kind":"json-schema","title":"org-settings-permissions-read-only","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permission that applies to this setting:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow end users to view their delegates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WRITE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow end users to set their own delegates"},"children":[]}]}]}]}]}]}],"type":"array","minItems":1,"maxItems":1,"items":{"$ref":"#/components/schemas/org-settings-permission"},"default":["READ"]}},"components/schemas/delegate-scope":{"id":"components/schemas/delegate-scope","kind":"json-schema","title":"delegate-scope","data":{"type":"object","required":["type"],"properties":{"type":{"type":"string","description":"The type of users that end users can assign as delegates","enum":["MANAGER","PEERS"],"x-enumDescriptions":{"MANAGER":"End users can only assign their manager as a delegate","PEERS":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This option must be used in conjunction with the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"MANAGER"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" option. It allows end users to select their manager's direct reports as delegates."},"children":[]}]}]}]}}}}},"components/schemas/delegate-scopes":{"id":"components/schemas/delegate-scopes","kind":"json-schema","title":"delegate-scopes","data":{"type":"array","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Restricts the scope of delegate assignment for end users when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"permissions"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" is set to "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WRITE"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". If this list is empty, end users can assign any user as their delegate."},"children":[]}]}]}],"items":{"$ref":"#/components/schemas/delegate-scope"}}},"components/schemas/integration-type":{"id":"components/schemas/integration-type","kind":"json-schema","title":"integration-type","data":{"type":"string","description":"Integration type","enum":["SLACK"],"x-enumDescriptions":{"SLACK":"Slack integration"}}},"components/schemas/org-settings":{"id":"components/schemas/org-settings","kind":"json-schema","title":"org-settings","data":{"type":"object","properties":{"delegates":{"type":"object","description":"Delegate settings","properties":{"enduser":{"description":"Delegate permission settings for end users","type":"object","properties":{"permissions":{"$ref":"#/components/schemas/org-settings-permissions-read-only"},"onlyFor":{"$ref":"#/components/schemas/delegate-scopes"}}}}},"governanceAI":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Governance AI settings"},"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 feature is excluded from the Okta for AI Agents - Core SKU,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is the version of Okta for AI Agents available to FedRAMP Moderate and FedRAMP High customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta for AI Agents - Core isn't available in Okta for US Military cells."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a current list of features that are excluded from the Okta for AI Agents - Core SKU,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.okta.com/help/s/article/okta-us-public-sector-limitations-or-exceptions?language=en_US"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta US Public Sector Limitations or Exceptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documentation."},"children":[]}]}]}]}],"properties":{"securityAccessReview":{"description":"Settings for Security Access Review powered by Governance AI","type":"object","properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if LLM-generated insights are enabled for security access reviews. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can generate AI-powered summaries to help assess risk."},"children":[]}]}]}]}}},"governanceAnalyzer":{"description":"Settings for Governance Analyzer powered by Governance AI","type":"object","properties":{"recommendationsEnabled":{"type":"boolean","description":"Indicates if ML based recommendations are enabled for certification campaign decisions."}}}}},"escalations":{"type":"object","description":"Escalation settings","properties":{"accessRequests":{"type":"object","description":"Access request escalation settings","properties":{"endUserCanEscalate":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if access request escalations are enabled for end users. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", end users can escalate requests to higher-level approvers."},"children":[]}]}]}]}}}}},"integrations":{"type":"object","description":"Integration settings","x-okta-lifecycle":{"lifecycle":"BETA"},"properties":{"supported":{"type":"array","description":"Supported integrations in this org","items":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/integration-type"}}}}}}}}},"components/schemas/org-settings-permissions":{"id":"components/schemas/org-settings-permissions","kind":"json-schema","title":"org-settings-permissions","data":{"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The permission that applies to this setting:"},"children":[]}]}]},{"$$mdtype":"Node","type":"table","attributes":{},"children":[{"$$mdtype":"Node","type":"thead","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Permission"},"children":[]}]}]},{"$$mdtype":"Node","type":"th","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Description"},"children":[]}]}]}]}]},{"$$mdtype":"Node","type":"tbody","attributes":{},"children":[{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"READ"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow end users to view their delegates"},"children":[]}]}]}]},{"$$mdtype":"Node","type":"tr","attributes":{},"children":[{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"WRITE"},"children":[]}]}]},{"$$mdtype":"Node","type":"td","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Allow end users to set their own delegates"},"children":[]}]}]}]}]}]}],"type":"array","items":{"$ref":"#/components/schemas/org-settings-permission"},"minItems":1,"maxItems":1}},"components/schemas/org-settings-patchable":{"id":"components/schemas/org-settings-patchable","kind":"json-schema","title":"org-settings-patchable","data":{"type":"object","properties":{"delegates":{"type":"object","description":"Delegate settings","properties":{"enduser":{"description":"Delegate permission settings for end users","type":"object","properties":{"permissions":{"$ref":"#/components/schemas/org-settings-permissions"},"onlyFor":{"$ref":"#/components/schemas/delegate-scopes"}}}}},"governanceAI":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Governance AI settings"},"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 feature is excluded from the Okta for AI Agents - Core SKU,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which is the version of Okta for AI Agents available to FedRAMP Moderate and FedRAMP High customers."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta for AI Agents - Core isn't available in Okta for US Military cells."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For a current list of features that are excluded from the Okta for AI Agents - Core SKU,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"please refer to the "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://support.okta.com/help/s/article/okta-us-public-sector-limitations-or-exceptions?language=en_US"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Okta US Public Sector Limitations or Exceptions"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" documentation."},"children":[]}]}]}]}],"properties":{"securityAccessReview":{"description":"Settings for Security Access Review powered by Governance AI","type":"object","properties":{"enabled":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if LLM-generated insights are enabled for security access reviews. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", users can generate AI-powered summaries to help assess risk."},"children":[]}]}]}]}}},"governanceAnalyzer":{"description":"Settings for Governance Analyzer powered by Governance AI","type":"object","properties":{"recommendationsEnabled":{"type":"boolean","description":"Indicates if ML based recommendations are enabled for certification campaign decisions."}}}}},"escalations":{"type":"object","description":"Escalation settings","properties":{"accessRequests":{"type":"object","description":"Access request escalation settings","properties":{"endUserCanEscalate":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Indicates if access request escalations are enabled for end users. If "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"true"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", end users can escalate requests to higher-level approvers."},"children":[]}]}]}]}}}}}}}},"components/schemas/integration-id":{"id":"components/schemas/integration-id","kind":"json-schema","title":"integration-id","data":{"type":"string","maxLength":20,"minLength":20,"format":"integration-id","pattern":"goi[0-9a-zA-Z]+","description":"The integration ID"}},"components/schemas/integration-status":{"id":"components/schemas/integration-status","kind":"json-schema","title":"integration-status","data":{"type":"string","description":"Integration status","enum":["CONNECTED","IN_PROGRESS","FAILED"],"x-enumDescriptions":{"CONNECTED":"The integration is connected.","IN_PROGRESS":"Enabling the integration connection is in progress.","FAILED":"The integration failed to connect."}}},"components/schemas/integration-readable":{"id":"components/schemas/integration-readable","kind":"json-schema","title":"integration-readable","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/integration-id"},"type":{"$ref":"#/components/schemas/integration-type"},"status":{"$ref":"#/components/schemas/integration-status"}}}},"components/schemas/integrations-readable":{"id":"components/schemas/integrations-readable","kind":"json-schema","title":"integrations-readable","data":{"type":"object","properties":{"data":{"type":"array","description":"List of integration settings","items":{"$ref":"#/components/schemas/integration-readable"}}}}},"components/schemas/integration-creatable":{"id":"components/schemas/integration-creatable","kind":"json-schema","title":"integration-creatable","data":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/integration-type"}}}},"components/schemas/integration-links":{"id":"components/schemas/integration-links","kind":"json-schema","title":"integration-links","data":{"type":"object","description":"Links to related resources for an integration","properties":{"authUrl":{"$ref":"#/components/schemas/link"}}}},"components/schemas/integration-full":{"id":"components/schemas/integration-full","kind":"json-schema","title":"integration-full","data":{"type":"object","properties":{"id":{"$ref":"#/components/schemas/integration-id"},"type":{"$ref":"#/components/schemas/integration-type"},"status":{"$ref":"#/components/schemas/integration-status"},"_links":{"$ref":"#/components/schemas/integration-links"}}}},"components/schemas/notifications-settings":{"id":"components/schemas/notifications-settings","kind":"json-schema","title":"notifications-settings","data":{"type":"object","description":"Notification settings for an integration","additionalProperties":false,"properties":{"enabled":{"type":"boolean","description":"Indicates that notifications are enabled for this integration"}},"required":["enabled"]}},"components/schemas/integrations-settings":{"id":"components/schemas/integrations-settings","kind":"json-schema","title":"integrations-settings","data":{"type":"object","description":"Integration settings for a specific integration","additionalProperties":false,"properties":{"type":{"type":"string","description":"Integration type","enum":["SLACK"],"x-enumDescriptions":{"SLACK":"Slack integration"}},"integrationId":{"$ref":"#/components/schemas/integration-id"},"notifications":{"$ref":"#/components/schemas/notifications-settings"}},"required":["type","integrationId"]}},"components/schemas/integrations":{"id":"components/schemas/integrations","kind":"json-schema","title":"integrations","data":{"type":"object","description":"Access certification integration settings for the org","properties":{"settings":{"type":"array","description":"Integration settings","items":{"$ref":"#/components/schemas/integrations-settings"}}}}},"components/schemas/org-certification-settings":{"id":"components/schemas/org-certification-settings","kind":"json-schema","title":"org-certification-settings","data":{"type":"object","description":"Certification settings for the org","properties":{"integrations":{"$ref":"#/components/schemas/integrations"}}}},"components/schemas/org-certification-settings-patchable":{"id":"components/schemas/org-certification-settings-patchable","kind":"json-schema","title":"org-certification-settings-patchable","data":{"type":"object","description":"Update certification settings for the org","properties":{"integrations":{"$ref":"#/components/schemas/integrations"}}}},"components/schemas/candidate-type":{"id":"components/schemas/candidate-type","kind":"json-schema","title":"candidate-type","data":{"type":"string","x-okta-ignore-redocly-rules-for-sdk":true,"description":"The type of assignment candidate","enum":["OKTA_USER","OKTA_GROUP"],"example":"OKTA_USER"}},"components/schemas/assignment-candidate":{"id":"components/schemas/assignment-candidate","kind":"json-schema","title":"assignment-candidate","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["externalId","type"],"description":"A candidate selected for assignment","properties":{"externalId":{"type":"string","maxLength":20,"minLength":20,"description":"ID of the candidate","example":"00u1a2b3c4d5e6f7g8h9"},"type":{"$ref":"#/components/schemas/candidate-type"},"orn":{"type":"string","format":"okta-principal-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The Okta user or group "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"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":" format."},"children":[]}]}]}],"example":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h9"},"delegator":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The original principal, if this candidate is a delegate."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only present when "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"skipDelegateReplacement=false"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the request query."},"children":[]}]}]}],"allOf":[{"$ref":"#/components/schemas/target-principal"},{"type":"object","properties":{"orn":{"type":"string","format":"okta-principal-orn","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The delegator "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in "},"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":" format."},"children":[]}]}]}],"example":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h4"}}}]}}}},"components/schemas/assignment-candidates-response":{"id":"components/schemas/assignment-candidates-response","kind":"json-schema","title":"assignment-candidates-response","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Assignment candidates response","properties":{"data":{"type":"array","description":"List of selected candidates","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/assignment-candidate"}}}}},"components/schemas/security-access-review-status":{"id":"components/schemas/security-access-review-status","kind":"json-schema","title":"security-access-review-status","data":{"type":"string","description":"Security access review status","enum":["ACTIVE","CLOSED","PENDING","ERROR"]}},"components/schemas/security-access-review-reviewer-type":{"id":"components/schemas/security-access-review-reviewer-type","kind":"json-schema","title":"security-access-review-reviewer-type","data":{"type":"string","description":"The type of reviewers involved in the security access review\n","enum":["USER"]}},"components/schemas/security-access-review-user-reviewer-settings":{"id":"components/schemas/security-access-review-user-reviewer-settings","kind":"json-schema","title":"security-access-review-user-reviewer-settings","data":{"type":"object","properties":{"includedUserIds":{"type":"array","description":"The list of reviewer user IDs for the security access review","minItems":1,"maxItems":10,"items":{"type":"string","minLength":20,"maxLength":20}}}}},"components/schemas/security-access-review-user-reviewer-settings-addnl-details":{"id":"components/schemas/security-access-review-user-reviewer-settings-addnl-details","kind":"json-schema","title":"security-access-review-user-reviewer-settings-addnl-details","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"Holds reviewer settings in the created security access review and more detailed reviewer details involved in the security access review.","allOf":[{"$ref":"#/components/schemas/security-access-review-user-reviewer-settings"},{"type":"object","properties":{"includedUserProfiles":{"type":"array","description":"The list of user reviewers for the security access review","minItems":0,"maxItems":10,"items":{"$ref":"#/components/schemas/principal-profile-enriched"}}}}]}},"components/schemas/security-access-review-reviewer-settings-response":{"id":"components/schemas/security-access-review-reviewer-settings-response","kind":"json-schema","title":"security-access-review-reviewer-settings-response","data":{"type":"object","description":"The reviewer settings for a security access review.\nThese include the type of reviewers and a list of reviewer IDs.\n","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/security-access-review-reviewer-type"},"userSettings":{"$ref":"#/components/schemas/security-access-review-user-reviewer-settings-addnl-details"}}}},"components/schemas/security-access-review-sparse":{"id":"components/schemas/security-access-review-sparse","kind":"json-schema","title":"security-access-review-sparse","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"type":"object","required":["id","status","name","endTime","reviewerSettings"],"properties":{"id":{"type":"string","description":"The ID of the security access review","minLength":20,"maxLength":20},"status":{"$ref":"#/components/schemas/security-access-review-status"},"name":{"type":"string","description":"The name of the security access review","minLength":1,"maxLength":200},"endTime":{"type":"string","format":"date-time","description":"The end time of the security access review"},"reviewerSettings":{"$ref":"#/components/schemas/security-access-review-reviewer-settings-response"}}}]}},"components/schemas/security-access-review-list-links":{"id":"components/schemas/security-access-review-list-links","kind":"json-schema","title":"security-access-review-list-links","data":{"type":"object","description":"Links available in security access review, access, or sub access list response","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"},"next":{"$ref":"#/components/schemas/link"}}}},"components/schemas/security-access-reviews":{"id":"components/schemas/security-access-reviews","kind":"json-schema","title":"security-access-reviews","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"data":{"description":"Security access reviews entries","type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-sparse"}},"_links":{"$ref":"#/components/schemas/security-access-review-list-links"}}}},"components/schemas/security-access-review-reviewer-settings":{"id":"components/schemas/security-access-review-reviewer-settings","kind":"json-schema","title":"security-access-review-reviewer-settings","data":{"type":"object","description":"The reviewer settings for a security access review.\nThese include the type of reviewers and a list of reviewer IDs.\n","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/security-access-review-reviewer-type"},"userSettings":{"$ref":"#/components/schemas/security-access-review-user-reviewer-settings"}}}},"components/schemas/security-access-review-request":{"id":"components/schemas/security-access-review-request","kind":"json-schema","title":"security-access-review-request","data":{"type":"object","description":"The request to create a security access review.\nThis includes the principal ID, the name of the security access review,\nthe end time, and the reviewer settings.\nThe end time defaults to seven days from the start time if not specified.\n","required":["principalId","name","reviewerSettings"],"properties":{"principalId":{"type":"string","description":"The Okta user ID in the security access review","minLength":20,"maxLength":20},"name":{"type":"string","description":"The name of the security access review","minLength":1,"maxLength":255},"endTime":{"type":"string","format":"date-time","description":"The date and time when the security access review closes, defaulting to seven days after the creation of the security access review. It must be at least one day and less than six months after creation."},"reviewerSettings":{"$ref":"#/components/schemas/security-access-review-reviewer-settings"}}}},"components/schemas/server-message-argument-type":{"id":"components/schemas/server-message-argument-type","kind":"json-schema","title":"server-message-argument-type","data":{"type":"string","description":"Type of the server message argument","enum":["STRING","RELATIVE_DATE_TO_NOW","NUMBER"],"x-enumDescriptions":{"STRING":"A string argument","RELATIVE_DATE_TO_NOW":"An ISO 8601 date string argument that's relative to the current date","NUMBER":"A number argument"}}},"components/schemas/server-message-argument":{"id":"components/schemas/server-message-argument","kind":"json-schema","title":"server-message-argument","data":{"type":"object","required":["value","type"],"properties":{"value":{"type":"string"},"type":{"$ref":"#/components/schemas/server-message-argument-type"}}}},"components/schemas/ai-message":{"id":"components/schemas/ai-message","kind":"json-schema","title":"ai-message","data":{"type":"object","description":"An AI-generated summary is presented as a long text string and sometimes multiple paragraphs.\nIf an AI summary fails to generate, an array of errors is returned with possible steps to correct the failure.","required":["message"],"properties":{"message":{"type":"string","description":"Generated summary message"},"deltaMessage":{"type":"string","description":"Generated summary message as a delta (for streaming)"},"errors":{"type":"array","minItems":0,"maxItems":100,"description":"Whenever summary generation has resulted in an error or blocked, the array of errors details the reasons","items":{"type":"object","required":["errorCode","errorMsg"],"properties":{"errorCode":{"type":"string","description":"A unique error code. Error codes are useful to execute additional actions."},"errorMsg":{"type":"string","description":"An error message detailing the problem"},"args":{"type":"array","description":"Any dynamic arguments that are needed to construct the whole message are supplied as an array of values","minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/server-message-argument"}}}}}}}},"components/schemas/security-access-review":{"id":"components/schemas/security-access-review","kind":"json-schema","title":"security-access-review","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["id","status","name","endTime","reviewerSettings"],"allOf":[{"$ref":"#/components/schemas/read-only-standard-properties"},{"type":"object","required":["status","name","endTime","reviewerSettings"],"properties":{"status":{"$ref":"#/components/schemas/security-access-review-status"},"name":{"type":"string","description":"The name of the security access review","minLength":1,"maxLength":255},"endTime":{"type":"string","format":"date-time","description":"The end time of the security access review"},"reviewerSettings":{"$ref":"#/components/schemas/security-access-review-reviewer-settings-response"},"summary":{"$ref":"#/components/schemas/ai-message"}}}]}},"components/schemas/security-access-reviews-stats":{"id":"components/schemas/security-access-reviews-stats","kind":"json-schema","title":"security-access-reviews-stats","data":{"type":"object","required":["activeCount","pendingCount","errorCount","closedCount"],"properties":{"activeCount":{"type":"integer","description":"The number of active security access reviews"},"pendingCount":{"type":"integer","description":"The number of pending security access reviews"},"errorCount":{"type":"integer","description":"The number of errored security access reviews"},"closedCount":{"type":"integer","description":"The number of closed security access reviews"}}}},"components/schemas/security-access-review-update-request":{"id":"components/schemas/security-access-review-update-request","kind":"json-schema","title":"security-access-review-update-request","data":{"type":"object","description":"The request to update a security access review.\nThis includes the end time and the reviewer settings.\n","properties":{"endTime":{"type":"string","format":"date-time","description":"The date and time when the security access review closes."},"reviewerSettings":{"$ref":"#/components/schemas/security-access-review-reviewer-settings"}}}},"components/schemas/security-access-review-action-type":{"id":"components/schemas/security-access-review-action-type","kind":"json-schema","title":"security-access-review-action-type","data":{"type":"string","description":"The type of action for the security access review","enum":["CLOSE_REVIEW","RESTORE_ALL_ACCESS"]}},"components/schemas/security-access-review-action":{"id":"components/schemas/security-access-review-action","kind":"json-schema","title":"security-access-review-action","data":{"type":"object","required":["actionType"],"properties":{"actionType":{"$ref":"#/components/schemas/security-access-review-action-type"}}}},"components/schemas/security-access-review-actions":{"id":"components/schemas/security-access-review-actions","kind":"json-schema","title":"security-access-review-actions","data":{"type":"object","properties":{"data":{"type":"array","description":"Returns all possible actions for the given security access review","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-action"}}}}},"components/schemas/security-access-review-action-request":{"id":"components/schemas/security-access-review-action-request","kind":"json-schema","title":"security-access-review-action-request","data":{"type":"object","required":["actionType"],"properties":{"actionType":{"$ref":"#/components/schemas/security-access-review-action-type"}}}},"components/schemas/security-access-review-principal-location":{"id":"components/schemas/security-access-review-principal-location","kind":"json-schema","title":"security-access-review-principal-location","data":{"type":"object","description":"The location details of the Okta user","properties":{"city":{"type":"string","description":"The city of the location","minLength":1,"maxLength":50},"state":{"type":"string","description":"The state of the location","minLength":1,"maxLength":50},"country":{"type":"string","description":"The country of the location","minLength":1,"maxLength":50}}}},"components/schemas/security-access-review-principal-last-login-info":{"id":"components/schemas/security-access-review-principal-last-login-info","kind":"json-schema","title":"security-access-review-principal-last-login-info","data":{"type":"object","description":"The latest sign-in details for the Okta user","properties":{"date":{"type":"string","format":"date-time","description":"Last sign-in date"},"location":{"$ref":"#/components/schemas/security-access-review-principal-location"},"device":{"type":"string","description":"Last sign-in device","minLength":1,"maxLength":255},"ipAddress":{"type":"string","description":"Last sign-in IP address","minLength":3,"maxLength":39}}}},"components/schemas/security-access-review-principal-okta-admin-role":{"id":"components/schemas/security-access-review-principal-okta-admin-role","kind":"json-schema","title":"security-access-review-principal-okta-admin-role","data":{"type":"object","required":["roleId","roleName"],"properties":{"roleId":{"type":"string","description":"Unique identifier for the Okta admin role","minLength":1,"maxLength":255},"roleName":{"type":"string","description":"Name of the Okta admin role","minLength":1,"maxLength":255}}}},"components/schemas/security-access-review-principal":{"id":"components/schemas/security-access-review-principal","kind":"json-schema","title":"security-access-review-principal","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"allOf":[{"$ref":"#/components/schemas/principal-profile-enriched"},{"type":"object","properties":{"department":{"type":"string","description":"The department of the Okta user","minLength":1,"maxLength":255},"manager":{"type":"string","description":"The manager of the Okta user","minLength":1,"maxLength":255},"role":{"type":"string","description":"The Okta user role","minLength":1,"maxLength":255},"homeLocation":{"$ref":"#/components/schemas/security-access-review-principal-location"},"lastLoginInfo":{"$ref":"#/components/schemas/security-access-review-principal-last-login-info"},"oktaAdminRoles":{"type":"array","description":"List of Okta admin roles assigned to the principal","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-principal-okta-admin-role"}},"_links":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/link"}}}}]}},"components/schemas/security-access-review-access-item-type":{"id":"components/schemas/security-access-review-access-item-type","kind":"json-schema","title":"security-access-review-access-item-type","data":{"type":"string","description":"Access item type","enum":["APPLICATION"]}},"components/schemas/security-access-review-access-item-severity":{"id":"components/schemas/security-access-review-access-item-severity","kind":"json-schema","title":"security-access-review-access-item-severity","data":{"type":"string","description":"The access severity","enum":["LOW","MEDIUM","HIGH"]}},"components/schemas/security-access-review-access-item-supported-action":{"id":"components/schemas/security-access-review-access-item-supported-action","kind":"json-schema","title":"security-access-review-access-item-supported-action","data":{"type":"string","description":"Supported actions","enum":["REVOKE_ACCESS","RESTORE_ACCESS","FLAG_FOR_MANUAL_REMEDIATION","FLAG_FOR_MANUAL_RESTORATION"],"x-enumDescriptions":{"REVOKE_ACCESS":"Revoke access for the user","RESTORE_ACCESS":"Restore access for the user","FLAG_FOR_MANUAL_REMEDIATION":"Access needs to be manually revoked for the user","FLAG_FOR_MANUAL_RESTORATION":"Access needs to be manually restored for the user"}}},"components/schemas/security-access-review-access-item-remediation-status":{"id":"components/schemas/security-access-review-access-item-remediation-status","kind":"json-schema","title":"security-access-review-access-item-remediation-status","data":{"type":"string","description":"Remediation status","enum":["PENDING_MANUAL_REMEDIATION","PENDING_MANUAL_RESTORATION","REMEDIATED","IN_PROGRESS","NONE"]}},"components/schemas/security-access-review-access-item-manual-remediation-type":{"id":"components/schemas/security-access-review-access-item-manual-remediation-type","kind":"json-schema","title":"security-access-review-access-item-manual-remediation-type","data":{"type":"string","description":"The reason manual remediation is required","enum":["GROUP_RULE","ENTITLEMENT_POLICY","COLLECTION","APP_GROUP","UNSUPPORTED_GROUP","FIRST_PARTY_APP"],"x-enumDescriptions":{"GROUP_RULE":"Manual remediation is required due to an assignment through a group rule.","ENTITLEMENT_POLICY":"Manual remediation is required due to an assignment through an entitlement policy.","COLLECTION":"Manual remediation is required due to an assignment through a collection.","APP_GROUP":"Manual remediation is required due to an assignment through an unsupported external app group.","UNSUPPORTED_GROUP":"Manual remediation is required due to an assignment through an unsupported group type.","FIRST_PARTY_APP":"Manual remediation is required due to an assignment through a first-party app."}}},"components/schemas/assignment-type":{"id":"components/schemas/assignment-type","kind":"json-schema","title":"assignment-type","data":{"type":"string","description":"The assignment type","enum":["INDIVIDUAL","GROUP","GROUP_RULE","APP_GROUP","ACCESS_REQUEST","ADMIN","POLICY","ENTITLEMENT"],"x-enumDescriptions":{"INDIVIDUAL":"Assigned directly to the user","GROUP":"Assigned through a group","GROUP_RULE":"Assigned through a group rule","APP_GROUP":"Assigned through an external app group","ACCESS_REQUEST":"Assigned through an access request","ADMIN":"Assigned by an admin","POLICY":"Assigned through a policy","ENTITLEMENT":"Assigned through an individual entitlement grant"}}},"components/schemas/target-governance-label":{"id":"components/schemas/target-governance-label","kind":"json-schema","title":"target-governance-label","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"properties":{"labelId":{"$ref":"#/components/schemas/label-id"},"name":{"type":"string","description":"Name of the label","minLength":1,"maxLength":50},"values":{"type":"array","description":"List of label values","maxItems":10,"items":{"allOf":[{"$ref":"#/components/schemas/label-value"}]}}},"required":["labelId","name","values"]}},"components/schemas/security-access-review-access-item-app-info":{"id":"components/schemas/security-access-review-access-item-app-info","kind":"json-schema","title":"security-access-review-access-item-app-info","data":{"type":"object","description":"The details of an app access item","required":["id","name","logoUrl"],"properties":{"id":{"type":"string","description":"The Okta app ID","minLength":20,"maxLength":20},"name":{"type":"string","description":"The app name","minLength":1,"maxLength":255},"logoUrl":{"type":"string","description":"The app logo URL","minLength":1,"maxLength":2048},"label":{"type":"string","description":"The app label","minLength":1,"maxLength":255},"lastAccessDate":{"type":"string","description":"The last time the app was accessed by the user","format":"date-time"},"assignedDate":{"type":"string","format":"date-time","description":"The date the app was assigned to the user"},"assignmentType":{"$ref":"#/components/schemas/assignment-type"},"applicationUsage":{"description":"The number of times the user has used the app in the last 90 days","type":"integer","format":"int64"},"lastAccessCertificationReviewedDate":{"type":"string","format":"date-time","description":"The last time the user/app pair was reviewed in an access certification campaign"},"lastSecurityAccessReviewDate":{"type":"string","format":"date-time","description":"The last time an action was taken on this app for the user in a security access review"},"lastDeviceLogin":{"type":"string","description":"Information about the last device used to log into the app","minLength":1,"maxLength":255},"activeEntitlements":{"description":"Any active entitlements for this app","type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/entitlement-property-full"}},"governanceLabels":{"description":"All governance labels applied to the app","type":"array","minItems":0,"maxItems":20,"items":{"$ref":"#/components/schemas/target-governance-label"}}}}},"components/schemas/security-access-review-sub-access-item-type":{"id":"components/schemas/security-access-review-sub-access-item-type","kind":"json-schema","title":"security-access-review-sub-access-item-type","data":{"type":"string","description":"The type of sub-access item","enum":["ENTITLEMENT_VALUE","ENTITLEMENT_BUNDLE","GROUP"]}},"components/schemas/security-access-review-access-item":{"id":"components/schemas/security-access-review-access-item","kind":"json-schema","title":"security-access-review-access-item","data":{"type":"object","required":["id","type","name","resourceId","severity","supportedActions"],"properties":{"id":{"type":"string","description":"The ID of the access item","minLength":20,"maxLength":20},"type":{"$ref":"#/components/schemas/security-access-review-access-item-type"},"name":{"type":"string","description":"The name of the access item","minLength":1,"maxLength":255},"resourceId":{"type":"string","description":"The ID of the resource for the access item in a security access review","minLength":20,"maxLength":20},"severity":{"$ref":"#/components/schemas/security-access-review-access-item-severity"},"supportedActions":{"type":"array","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-access-item-supported-action"}},"remediationStatus":{"$ref":"#/components/schemas/security-access-review-access-item-remediation-status"},"manualRemediationTypes":{"type":"array","description":"The reasons for manual remediation","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-access-item-manual-remediation-type"}},"appInfo":{"$ref":"#/components/schemas/security-access-review-access-item-app-info"},"summary":{"$ref":"#/components/schemas/ai-message"},"subAccessTypes":{"type":"array","description":"A list of sub-access types for the access item","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-sub-access-item-type"}},"_links":{"type":"object","description":"Links related to the access item","additionalProperties":{"$ref":"#/components/schemas/link"}}}}},"components/schemas/security-access-review-access-items":{"id":"components/schemas/security-access-review-access-items","kind":"json-schema","title":"security-access-review-access-items","data":{"type":"object","properties":{"data":{"description":"List of access items in the security access review","type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-access-item"}},"_links":{"$ref":"#/components/schemas/security-access-review-list-links"}}}},"components/schemas/security-access-review-sub-access-item-entitlement-type":{"id":"components/schemas/security-access-review-sub-access-item-entitlement-type","kind":"json-schema","title":"security-access-review-sub-access-item-entitlement-type","data":{"type":"string","description":"The entitlement type","enum":["ENTITLEMENT_VALUE","ENTITLEMENT_BUNDLE"]}},"components/schemas/collection-info-sparse":{"id":"components/schemas/collection-info-sparse","kind":"json-schema","title":"collection-info-sparse","data":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"Unique identifier of the collection"},"name":{"type":"string","description":"Name of the collection"}}}},"components/schemas/security-access-review-sub-access-item-entitlement-info":{"id":"components/schemas/security-access-review-sub-access-item-entitlement-info","kind":"json-schema","title":"security-access-review-sub-access-item-entitlement-info","data":{"type":"object","description":"The entitlement details for the sub-access item","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/security-access-review-sub-access-item-entitlement-type"},"description":{"type":"string","description":"A brief description of the entitlement value or bundle","minLength":1,"maxLength":1024},"entitlementDescription":{"type":"string","description":"A brief description of the entitlement associated with the value","minLength":1,"maxLength":1024},"assignedDate":{"type":"string","format":"date-time","description":"The date the entitlement or bundle was assigned to the user"},"assignmentType":{"$ref":"#/components/schemas/assignment-type"},"collectionsAssigning":{"description":"Collections assigning this resource","type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/collection-info-sparse"}},"entitlements":{"description":"The entitlements included in the entitlement bundle","type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/entitlement-property-full"}},"lastAccessCertificationReviewedDate":{"type":"string","format":"date-time","description":"The last time the user/entitlement pair was reviewed in an access certification campaign"},"lastSecurityAccessReviewDate":{"type":"string","format":"date-time","description":"The last time an action was taken on this entitlement for the user in a security access review"},"governanceLabels":{"description":"All governance labels applied to the entitlement value or bundle","type":"array","minItems":0,"maxItems":20,"items":{"$ref":"#/components/schemas/target-governance-label"}}}}},"components/schemas/security-access-review-sub-access-item-group-info":{"id":"components/schemas/security-access-review-sub-access-item-group-info","kind":"json-schema","title":"security-access-review-sub-access-item-group-info","data":{"type":"object","description":"The group details for the sub-access item","properties":{"description":{"type":"string","description":"A brief description of the group","minLength":1,"maxLength":1024},"assignedDate":{"type":"string","format":"date-time","description":"The date the group was assigned to the user"},"groupOwner":{"type":"string","minLength":1,"maxLength":255,"description":"The group owner name"},"assignmentType":{"$ref":"#/components/schemas/assignment-type"},"lastAccessCertificationReviewedDate":{"type":"string","format":"date-time","description":"The last time the user/group pair was reviewed in an access certification campaign"},"lastSecurityAccessReviewDate":{"type":"string","format":"date-time","description":"The last time an action was taken on this group for the user in a security access review"},"governanceLabels":{"description":"All governance labels applied to the group","type":"array","minItems":0,"maxItems":20,"items":{"$ref":"#/components/schemas/target-governance-label"}}}}},"components/schemas/security-access-review-sub-access-item":{"id":"components/schemas/security-access-review-sub-access-item","kind":"json-schema","title":"security-access-review-sub-access-item","data":{"type":"object","required":["id","name","type","resourceId","severity","supportedActions"],"properties":{"id":{"type":"string","description":"The ID of the sub-access item","minLength":20,"maxLength":20},"name":{"type":"string","description":"The name of the sub-access item","minLength":1,"maxLength":255},"type":{"$ref":"#/components/schemas/security-access-review-sub-access-item-type"},"resourceId":{"type":"string","description":"The ID of the resource for the sub-access item","minLength":20,"maxLength":20},"severity":{"$ref":"#/components/schemas/security-access-review-access-item-severity"},"supportedActions":{"type":"array","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-access-item-supported-action"}},"remediationStatus":{"$ref":"#/components/schemas/security-access-review-access-item-remediation-status"},"manualRemediationTypes":{"type":"array","description":"The reasons for manual remediation","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-access-item-manual-remediation-type"}},"entitlementInfo":{"$ref":"#/components/schemas/security-access-review-sub-access-item-entitlement-info"},"groupInfo":{"$ref":"#/components/schemas/security-access-review-sub-access-item-group-info"}}}},"components/schemas/security-access-review-sub-access-items":{"id":"components/schemas/security-access-review-sub-access-items","kind":"json-schema","title":"security-access-review-sub-access-items","data":{"type":"object","properties":{"data":{"description":"List of access items in the security access review","type":"array","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-sub-access-item"}},"_links":{"$ref":"#/components/schemas/security-access-review-list-links"}}}},"components/schemas/security-access-review-anomaly-type":{"id":"components/schemas/security-access-review-anomaly-type","kind":"json-schema","title":"security-access-review-anomaly-type","data":{"type":"string","description":"The access item target type","enum":["SOD_CONFLICT","ASSIGNMENT_METHOD","PAST_GOVERNANCE_DECISIONS","USAGE_HISTORY"]}},"components/schemas/server-message":{"id":"components/schemas/server-message","kind":"json-schema","title":"server-message","data":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"Server message with detailed content","minLength":1,"maxLength":1000},"args":{"type":"array","description":"Dynamic arguments, used to construct the whole message, are supplied as an array of values.","minItems":0,"maxItems":100,"items":{"$ref":"#/components/schemas/server-message-argument"}}}}},"components/schemas/server-extended-message":{"id":"components/schemas/server-extended-message","kind":"json-schema","title":"server-extended-message","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"description":"An extended version of the server message that includes a few additional properties","allOf":[{"$ref":"#/components/schemas/server-message"},{"type":"object","required":["messageCode"],"properties":{"messageCode":{"type":"string","description":"A unique message code. You can use the message code for additional processes, such as localization.","minLength":1,"maxLength":255}}}]}},"components/schemas/security-access-review-sod-conflict-operator":{"id":"components/schemas/security-access-review-sod-conflict-operator","kind":"json-schema","title":"security-access-review-sod-conflict-operator","data":{"type":"string","description":"The boolean operator used to calculate the conflict between the given entitlement lists in the SOD rule","enum":["AND"]}},"components/schemas/security-access-review-conflicted-entitlement-list-scope":{"id":"components/schemas/security-access-review-conflicted-entitlement-list-scope","kind":"json-schema","title":"security-access-review-conflicted-entitlement-list-scope","data":{"type":"string","description":"Shows the scope used to calculate the conflict between two entitlement lists","enum":["ANY_ONE_OF","ALL_OF"]}},"components/schemas/security-access-review-conflicted-entitlement-value":{"id":"components/schemas/security-access-review-conflicted-entitlement-value","kind":"json-schema","title":"security-access-review-conflicted-entitlement-value","data":{"type":"object","required":["id","name","sourceOfConflict"],"properties":{"id":{"type":"string","description":"ID of entitlement value","minLength":20,"maxLength":20},"name":{"type":"string","description":"Entitlement value name","minLength":1,"maxLength":255},"sourceOfConflict":{"type":"boolean","description":"A true value indicates that the associated resource is for this entitlement value or is a bundle that contains this entitlement value."}}}},"components/schemas/security-access-review-conflicted-entitlement":{"id":"components/schemas/security-access-review-conflicted-entitlement","kind":"json-schema","title":"security-access-review-conflicted-entitlement","data":{"type":"object","required":["id","name","values"],"properties":{"id":{"type":"string","description":"Entitlement ID","minLength":20,"maxLength":20},"name":{"type":"string","description":"Entitlement name","minLength":1,"maxLength":255},"values":{"type":"array","description":"List of entitlement values","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-conflicted-entitlement-value"}}}}},"components/schemas/security-access-review-sod-conflict-conflicted-entitlement-info":{"id":"components/schemas/security-access-review-sod-conflict-conflicted-entitlement-info","kind":"json-schema","title":"security-access-review-sod-conflict-conflicted-entitlement-info","data":{"type":"object","required":["listName","entitlements","scope"],"properties":{"listName":{"type":"string","description":"The entitlement list name","minLength":1,"maxLength":255},"scope":{"$ref":"#/components/schemas/security-access-review-conflicted-entitlement-list-scope"},"entitlements":{"type":"array","description":"List of entitlements","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-conflicted-entitlement"}}}}},"components/schemas/security-access-review-sod-conflict":{"id":"components/schemas/security-access-review-sod-conflict","kind":"json-schema","title":"security-access-review-sod-conflict","data":{"type":"object","required":["id","name","operator","conflictedEntitlements"],"properties":{"id":{"type":"string","description":"ID of SOD conflict rule","minLength":20,"maxLength":20},"name":{"type":"string","description":"Name of SOD conflict rule","minLength":1,"maxLength":255},"description":{"type":"string","description":"Description of SOD conflict rule","minLength":1,"maxLength":1024},"operator":{"$ref":"#/components/schemas/security-access-review-sod-conflict-operator"},"conflictedEntitlements":{"type":"array","description":"List of conflicted entitlements that caused this SOD conflict","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-sod-conflict-conflicted-entitlement-info"}}}}},"components/schemas/security-access-review-anomaly":{"id":"components/schemas/security-access-review-anomaly","kind":"json-schema","title":"security-access-review-anomaly","data":{"type":"object","required":["type","severity","subtext"],"properties":{"type":{"$ref":"#/components/schemas/security-access-review-anomaly-type"},"severity":{"$ref":"#/components/schemas/security-access-review-access-item-severity"},"subtext":{"$ref":"#/components/schemas/server-extended-message"},"sodConflicts":{"type":"array","description":"A list of separation of duties (SOD) conflicts caused by a user's access to an entitlement","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-sod-conflict"}}}}},"components/schemas/security-access-review-anomalies":{"id":"components/schemas/security-access-review-anomalies","kind":"json-schema","title":"security-access-review-anomalies","data":{"type":"object","properties":{"data":{"type":"array","description":"Lists all anomalies identified.","minItems":0,"maxItems":50,"items":{"$ref":"#/components/schemas/security-access-review-anomaly"}}}}},"components/schemas/security-access-review-accesses-action-request":{"id":"components/schemas/security-access-review-accesses-action-request","kind":"json-schema","title":"security-access-review-accesses-action-request","data":{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/security-access-review-access-item-supported-action"}}}},"components/schemas/security-access-review-history-item":{"id":"components/schemas/security-access-review-history-item","kind":"json-schema","title":"security-access-review-history-item","data":{"type":"object","required":["id","systemGenerated","timestamp","message"],"properties":{"id":{"type":"string","minLength":20,"maxLength":20},"systemGenerated":{"type":"boolean","description":"Indicates if the action or change was made by Okta"},"timestamp":{"type":"string","description":"The date and time of the action or change","format":"date-time"},"message":{"type":"string","minLength":1,"maxLength":1000},"principalProfile":{"$ref":"#/components/schemas/principal-profile-enriched"}}}},"components/schemas/security-access-review-history-items":{"id":"components/schemas/security-access-review-history-items","kind":"json-schema","title":"security-access-review-history-items","data":{"type":"object","properties":{"data":{"type":"array","description":"Lists all events occurred on a given security access review. The history covers all such events and actions.","minItems":0,"maxItems":200,"items":{"$ref":"#/components/schemas/security-access-review-history-item"}},"_links":{"$ref":"#/components/schemas/security-access-review-list-links"}}}},"components/schemas/security-access-review-comment-request":{"id":"components/schemas/security-access-review-comment-request","kind":"json-schema","title":"security-access-review-comment-request","data":{"type":"object","required":["comment"],"properties":{"comment":{"type":"string","description":"A comment for the security access review","minLength":1,"maxLength":1000}}}},"components/schemas/ai-summary-stream-sse-message":{"id":"components/schemas/ai-summary-stream-sse-message","kind":"json-schema","title":"ai-summary-stream-sse-message","data":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"The server-sent events (SSE) format:"},"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":"The "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property contains a JSON string."},"children":[]}]}]},{"$$mdtype":"Node","type":"item","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":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" property contains chunks of the AI-generated summary."},"children":[]}]}]}]}],"required":["data"],"properties":{"id":{"type":"string","description":"The event ID"},"event":{"type":"string","description":"The event type"},"data":{"type":"string","description":"The event data in JSON string format","example":"{\"message\": \"A detailed message constructed so far\", \"deltaMessage\": \"constructed so far\", \"errors\": []}"}}}},"components/schemas/operation-status":{"id":"components/schemas/operation-status","kind":"json-schema","title":"operation-status","data":{"type":"string","enum":["RUNNING","FAILED","COMPLETED","CANCELED"],"x-enumDescriptions":{"RUNNING":"The operation was created and is currently in progress.","FAILED":"The operation failed.","COMPLETED":"The operation completed successfully.","CANCELED":"The operation was canceled."},"description":"The status of the operation\n"}},"components/schemas/operation-created":{"id":"components/schemas/operation-created","kind":"json-schema","title":"operation-created","data":{"description":"The ISO 8601 formatted date and time of when the operation was created","type":"string","format":"date-time","readOnly":true}},"components/schemas/operation-completed":{"id":"components/schemas/operation-completed","kind":"json-schema","title":"operation-completed","data":{"description":"The ISO 8601 formatted date and time of when the operation completed","type":"string","format":"date-time","readOnly":true}},"components/schemas/operation-links":{"id":"components/schemas/operation-links","kind":"json-schema","title":"operation-links","data":{"type":"object","description":"Link relations available for the operation","required":["self"],"properties":{"self":{"$ref":"#/components/schemas/link"}}}},"components/schemas/operation":{"id":"components/schemas/operation","kind":"json-schema","title":"operation","data":{"description":"Representation of an operation","required":["id","type","status","_links"],"properties":{"id":{"description":"ID of the operation","type":"string","minLength":1},"type":{"description":"The operation type","type":"string","minLength":1},"status":{"$ref":"#/components/schemas/operation-status"},"created":{"$ref":"#/components/schemas/operation-created"},"completed":{"$ref":"#/components/schemas/operation-completed"},"timeElapsedInSeconds":{"type":"integer","description":"Elapsed time since the start of the operation, in seconds","minimum":0},"_links":{"$ref":"#/components/schemas/operation-links"}}}},"components/schemas/resource-inventory-stats":{"id":"components/schemas/resource-inventory-stats","kind":"json-schema","title":"resource-inventory-stats","data":{"type":"object","required":["apps","groups","entitlementValues","entitlementBundles","collections"],"properties":{"apps":{"type":"integer","description":"The number of app resources matching the search query","readOnly":true},"groups":{"type":"integer","description":"The number of group resources matching the search query","readOnly":true},"entitlementValues":{"type":"integer","description":"The number of entitlement value resources matching the search query","readOnly":true},"entitlementBundles":{"type":"integer","description":"The number of entitlement bundle resources matching the search query","readOnly":true},"collections":{"type":"integer","description":"The number of collection resources matching the search query","readOnly":true}}}},"components/schemas/resource-type-enum":{"id":"components/schemas/resource-type-enum","kind":"json-schema","title":"resource-type-enum","data":{"type":"string","description":"The type of resource in the inventory","enum":["apps","groups","entitlement-values","entitlement-bundles","collections"]}},"components/schemas/resource-status-enum":{"id":"components/schemas/resource-status-enum","kind":"json-schema","title":"resource-status-enum","data":{"type":"string","enum":["active","inactive"],"description":"Current status of the resource","example":"active"}},"components/schemas/resource-stats":{"id":"components/schemas/resource-stats","kind":"json-schema","title":"resource-stats","data":{"type":"object","description":"Statistical information about the resource. Not all properties are applicable to every resource type.","properties":{"apps":{"type":"integer","description":"Number of associated apps","example":42},"groups":{"type":"integer","description":"Number of associated groups","example":5},"users":{"type":"integer","description":"Number of associated users","example":28},"owners":{"type":"integer","description":"Number of owners","example":1},"entitlements":{"type":"integer","description":"Number of entitlements","example":21},"labels":{"type":"integer","description":"Number of associated labels","example":3}},"additionalProperties":{"type":"integer"}}},"components/schemas/embedded-item":{"id":"components/schemas/embedded-item","kind":"json-schema","title":"embedded-item","data":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"Unique identifier for the embedded resource"},"name":{"type":"string","description":"Display name of the embedded resource"},"metadata":{"type":"object","description":"Additional metadata specific to this embedded resource type","additionalProperties":true}},"additionalProperties":false}},"components/schemas/resource":{"id":"components/schemas/resource","kind":"json-schema","title":"resource","data":{"allOf":[{"type":"object","required":["type"],"properties":{"type":{"$ref":"#/components/schemas/resource-type-enum"},"orn":{"type":"string","format":"okta-resource-orn","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":"id"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" of the resource in "},"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 format"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}]},"name":{"type":"string","description":"Display name of the resource","example":"My Salesforce Group"},"description":{"type":"string","description":"Detailed description of the resource","example":"Group description"},"status":{"$ref":"#/components/schemas/resource-status-enum"},"logos":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri","description":"URL to the logo image"}}}},"stats":{"$ref":"#/components/schemas/resource-stats"},"metadata":{"type":"object","description":"Additional metadata associated with the resource","additionalProperties":true,"example":{"values":["SOX","PII"],"color":"blue"}},"_embedded":{"type":"object","description":"Embedded related resources","properties":{"owners":{"type":"array","items":{"$ref":"#/components/schemas/embedded-item"}},"apps":{"type":"array","items":{"$ref":"#/components/schemas/embedded-item"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/embedded-item"}}}}}},{"$ref":"#/components/schemas/read-only-standard-properties"}]}},"components/schemas/resource-inventory-list":{"id":"components/schemas/resource-inventory-list","kind":"json-schema","title":"resource-inventory-list","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["data","_links","metadata"],"properties":{"data":{"type":"array","description":"List of resources on the current page","items":{"$ref":"#/components/schemas/resource"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"components/schemas/filter-type-enum":{"id":"components/schemas/filter-type-enum","kind":"json-schema","title":"filter-type-enum","data":{"type":"string","description":"The type of filtering options to retrieve","enum":["apps","labels","owners"]}},"components/schemas/resource-inventory-filter-option":{"id":"components/schemas/resource-inventory-filter-option","kind":"json-schema","title":"resource-inventory-filter-option","data":{"type":"object","required":["id","name"],"properties":{"id":{"type":"string","description":"Unique identifier for the filter option. For owners, this is the Okta user ID.","example":"0oafxqCAJWWGELFTYASJ"},"name":{"type":"string","description":"Display name of the filter option","example":"Salesforce"},"logo":{"type":"string","format":"uri","description":"URL to a logo image. Only present for app filter options.","example":"https://example.okta.com/img/salesforce-logo.png"},"metadata":{"type":"object","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additional metadata properties for the filter option. Only present for certain filter types."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"For the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"labels"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" filter type, metadata contains:"},"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":"values"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": array of label values, each with "},"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":"name"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", and "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"backgroundColor"},"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":"backgroundColor"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":": ["},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"red"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"orange"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"yellow"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"green"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"blue"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"purple"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"teal"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"beige"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":", "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"gray"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"]"},"children":[]}]}]}]}]}]}],"additionalProperties":true}}}},"components/schemas/resource-inventory-filter-options-list":{"id":"components/schemas/resource-inventory-filter-options-list","kind":"json-schema","title":"resource-inventory-filter-options-list","data":{"type":"object","x-okta-ignore-redocly-rules-for-sdk":true,"required":["data","_links","metadata"],"properties":{"data":{"type":"array","description":"List of filtering options on the current page","items":{"$ref":"#/components/schemas/resource-inventory-filter-option"}},"_links":{"$ref":"#/components/schemas/list-links"},"metadata":{"$ref":"#/components/schemas/list-metadata"}}}},"schema_1377":{"kind":"json-schema","data":{"type":"object","properties":{"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_1377"},"schema_1378":{"kind":"json-schema","data":{"type":"string"},"id":"schema_1378"},"schema_1379":{"kind":"json-schema","data":{"type":"string","example":"00u68w6vzKLultXS97g6"},"id":"schema_1379"},"schema_1380":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":200,"minimum":1},"id":"schema_1380"},"schema_1381":{"kind":"json-schema","data":{"type":"array","uniqueItems":false,"minItems":1,"maxItems":1,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A property of items within the collection, optionally followed by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"children":[]}]}]}]},"default":["created asc"]},"id":"schema_1381"},"schema_1382":{"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's 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_1382"},"schema_1383":{"kind":"json-schema","data":{"type":"object","properties":{"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","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location of the campaign that was launched."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the campaign that was launched has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schedule type, then the location of the launched campaign that's returned is based on the recurring schedule."},"children":[]}]}]}]}},"required":["X-Rate-Limit-Limit","X-Rate-Limit-Remaining","X-Rate-Limit-Reset","Location"]},"id":"schema_1383"},"schema_1384":{"kind":"json-schema","data":{"type":"object","properties":{"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","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Location of the campaign that was completed."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the campaign that was completed has the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"RECURRING"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" schedule type, then the location that's returned provides the completed campaign."},"children":[]}]}]}]}},"required":["X-Rate-Limit-Limit","X-Rate-Limit-Remaining","X-Rate-Limit-Reset","Location"]},"id":"schema_1384"},"schema_1385":{"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":"reassignReview"},"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_1385"},"schema_1386":{"kind":"json-schema","data":{"$ref":"#/components/schemas/scim-filter"},"id":"schema_1386"},"schema_1387":{"kind":"json-schema","data":{"type":"array","uniqueItems":false,"minItems":1,"maxItems":1,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A property of items within the collection, optionally followed by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"children":[]}]}]}]},"default":["name asc"]},"id":"schema_1387"},"schema_1388":{"kind":"json-schema","data":{"type":"integer","default":200,"maximum":200,"minimum":1},"id":"schema_1388"},"schema_1389":{"kind":"json-schema","data":{"type":"array","uniqueItems":false,"minItems":1,"maxItems":1,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A property of items within the collection, optionally followed by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"children":[]}]}]}]},"default":["id asc"]},"id":"schema_1389"},"schema_1390":{"kind":"json-schema","data":{"$ref":"#/components/schemas/entitlement-bundle-id"},"id":"schema_1390"},"schema_1391":{"kind":"json-schema","data":{"$ref":"#/components/schemas/order-by"},"id":"schema_1391"},"schema_1392":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["full_entitlements"]}},"id":"schema_1392"},"schema_1393":{"kind":"json-schema","data":{"$ref":"#/components/schemas/id"},"id":"schema_1393"},"schema_1394":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","example":"target.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND target.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"id":"schema_1394"},"schema_1395":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["full_entitlements","metadata"],"x-enumDescriptions":{"full_entitlements":"Include complete entitlements in the response","metadata":"Include metadata such as collection generating the grant in the response"}}},"id":"schema_1395"},"schema_1396":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/grants-list"},{"$ref":"#/components/schemas/grants-list-with-entitlements"}]},"id":"schema_1396"},"schema_1397":{"kind":"json-schema","data":{"oneOf":[{"$ref":"#/components/schemas/grant-full"},{"$ref":"#/components/schemas/grant-full-with-entitlements"}]},"id":"schema_1397"},"schema_1398":{"kind":"json-schema","data":{"type":"string","example":"governance/api/v1/principal-entitlements-changes/cmVwMWtOQ2NmQnhhRWVEbXcwZzI6cmVwOHBCVVRWVG9na2lYNWUwZzI"},"id":"schema_1398"},"schema_1399":{"kind":"json-schema","data":{"type":"integer","default":20,"maximum":100,"minimum":1},"id":"schema_1399"},"schema_1400":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["counts"],"x-enumDescriptions":{"counts":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Includes a count of entitlement history records in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"metadata.total"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" response"},"children":[]}]}]}]},"example":"counts"}},"id":"schema_1400"},"schema_1401":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["counts"]}},"id":"schema_1401"},"schema_1402":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","maxLength":255,"example":"name sw \"Sales\""},"id":"schema_1402"},"schema_1403":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["entitlements","entitlementValueCount"],"x-enumDescriptions":{"entitlements":"Returns entitlement detail and value count in the response","entitlementValueCount":"Returns only the entitlement value count in the response"}}},"id":"schema_1403"},"schema_1404":{"kind":"json-schema","data":{"description":"Payload for adding resources to a collection","type":"array","items":{"$ref":"#/components/schemas/collection-resource-creatable"},"maxItems":25},"id":"schema_1404"},"schema_1405":{"kind":"json-schema","data":{"type":"array","items":{"$ref":"#/components/schemas/assigned-principal-full"}},"id":"schema_1405"},"schema_1406":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["counts"],"x-enumDescriptions":{"counts":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Returns "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"resourceConfiguration.counts"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" in the response"},"children":[]}]}]}]}}},"id":"schema_1406"},"schema_1407":{"kind":"json-schema","data":{"description":"Payload for adding resources to a collection","type":"array","items":{"$ref":"#/components/schemas/collection-resource-creatable-v2"},"maxItems":25},"id":"schema_1407"},"schema_1408":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["labels","relatedApps","resourceProfile"],"x-enumDescriptions":{"labels":"Returns governance labels associated with the resource","relatedApps":"Returns related apps for group and push group resources. Ignored for app resources.","resourceProfile":"Returns the resource profile details (name, label, logo) for the resource."}}},"id":"schema_1408"},"schema_1409":{"kind":"json-schema","data":{"type":"string","format":"scim-filter","example":"name sw \"Process\""},"id":"schema_1409"},"schema_1410":{"kind":"json-schema","data":{"type":"array","items":{"type":"string","enum":["parent_resource_owner"],"x-enumDescriptions":{"parent_resource_owner":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"If the parent resource has an owner assigned, then the parent resource is included in the "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"data"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" array response."},"children":[]}]}]}]}}},"id":"schema_1410"},"schema_1411":{"kind":"json-schema","data":{"type":"string","example":"delegatorId eq \"00ub0oNGTSWTBKOLGLNR\" OR delegatorId eq \"00ub0oNGTSWTBKOLGLNS\""},"id":"schema_1411"},"schema_1412":{"kind":"json-schema","data":{"type":"array","uniqueItems":false,"minItems":1,"maxItems":1,"items":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"A property of items within the collection, optionally followed by a "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" asc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" or "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":" desc"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" suffix."},"children":[]}]}]}]},"default":["priority desc"]},"id":"schema_1412"},"schema_1413":{"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's another page of results."},"children":[]}]}]}]}]}}},"id":"schema_1413"}},"exampleStore":{"components/examples/campaigns-list-response-01-filtered-by-name":{"id":"components/examples/campaigns-list-response-01-filtered-by-name","value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=2&filter%3Dname%20eq%20%22Sales%20Review%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dname%20eq%20%22Sales%20Review%22"}}},"summary":"List of campaigns filtered by name.","description":"The list of campaigns which is filtered by specific name of the campaign"},"components/examples/campaigns-list-response-01-filtered-by-status":{"id":"components/examples/campaigns-list-response-01-filtered-by-status","value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"HR Review","description":"Review access of all HR team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=2&filter%3Dstatus%20eq%20%22COMPLETED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22"}}},"summary":"List of campaigns filtered by status.","description":"The list of campaigns that are all in scheduled state"},"components/examples/campaigns-list-response-01-filtered-by-multiple-status":{"id":"components/examples/campaigns-list-response-01-filtered-by-multiple-status","value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"summary":"List of campaigns filtered by multiple statuses.","description":"The list of campaigns that are all in Completed and Scheduled state."},"components/examples/campaigns-list-response-02-filtered-by-multiple-status-includes-recurring-campaigns":{"id":"components/examples/campaigns-list-response-02-filtered-by-multiple-status-includes-recurring-campaigns","value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}},{"id":"icibblYhjKVKNxdcs0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"COMPLETED","recurringCampaignId":"icidlVDNMuEKpwRZc0g1","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"icidlVDNMuEKpwRZc0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icidlVDNMuEKpwRZc0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"summary":"List of campaigns filtered by multiple statuses. The results include recurring campaigns too"},"components/examples/campaigns-list-response-02-filtered-by-multiple-status-includes-reviewer-group-and-owners":{"id":"components/examples/campaigns-list-response-02-filtered-by-multiple-status-includes-reviewer-group-and-owners","value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}},{"id":"icibblYhjKVKNxdcs0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"GROUP","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"COMPLETED","recurringCampaignId":"icidlVDNMuEKpwRZc0g1","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"icidlVDNMuEKpwRZc0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"RESOURCE_OWNER","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icidlVDNMuEKpwRZc0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"}}},{"id":"ici8t2ROlCM5y664Q0g2","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"MULTI_LEVEL","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici8t2ROlCM5y664Q0g2%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"summary":"List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too"},"components/examples/campaigns-list-response-03-user-centric-app-group":{"id":"components/examples/campaigns-list-response-03-user-centric-app-group","value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}},{"id":"icibblYhjKVKNxdcs0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"GROUP","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"COMPLETED","recurringCampaignId":"icidlVDNMuEKpwRZc0g1","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"icidlVDNMuEKpwRZc0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"RESOURCE_OWNER","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"ici8t2ROlCM5y664Q0g2","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"MULTI_LEVEL","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"summary":"List of campaigns filtered by campaign type. The results are for user campaigns."},"components/examples/invalid-filter":{"id":"components/examples/invalid-filter","value":{"errorCode":"E0000053","errorSummary":"Invalid SCIM filter","errorLink":"E0000053","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `filter` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/filter","domain":"governance"}]}},"components/examples/invalid-after":{"id":"components/examples/invalid-after","value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `after` parameter isn't valid. Use links in response bodies or headers as the source of truth for paginated requests that contain an `after` parameter.","reason":"INVALID_AFTER_PARAMETER","locationType":"query","location":"/query/after","domain":"governance"}]}},"components/examples/invalid-sort":{"id":"components/examples/invalid-sort","value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"summary":"Invalid `orderBy` parameter error response"},"components/examples/invalid-limit":{"id":"components/examples/invalid-limit","value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"summary":"Invalid `limit` parameter error response"},"components/examples/campaigns-creatable-01-group-with-user-scope":{"id":"components/examples/campaigns-creatable-01-group-with-user-scope","value":{"campaignType":"RESOURCE","description":"Group Campaign | User Reviewer Expression","name":"Group Campaign | User Reviewer Expression","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T13:43:40.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GROUP","resourceId":"00gg2gzn7m1Aw2zAs1d7"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"reviewerScopeExpression":"user.profile.reviewerId","type":"REVIEWER_EXPRESSION","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"},"reportingSettings":{"createReportingPackageEnabled":true}},"summary":"Campaign using groups with users as scope","description":"This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used."},"components/examples/campaigns-creatable-01-group-with-user-expression-scope":{"id":"components/examples/campaigns-creatable-01-group-with-user-expression-scope","value":{"campaignType":"RESOURCE","description":"Group Campaign | User Reviewer Expression | User Expression","name":"Group Campaign | User Reviewer Expression | User Expression","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T13:37:47.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GROUP","resourceId":"00gg2gzn7m1Aw2zAs1d7"}]},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.title==\"Engineer\""},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"reviewerScopeExpression":"user.profile.reviewerId","type":"REVIEWER_EXPRESSION","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Campaign using group with user expression scope","description":"This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group."},"components/examples/campaigns-creatable-02-app-with-users-scope":{"id":"components/examples/campaigns-creatable-02-app-with-users-scope","value":{"campaignType":"RESOURCE","description":"App Campaign | User Reviewer | Without Entitlements","name":"App Campaign | User Reviewer | Without Entitlements","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T14:15:23.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":false,"targetResources":[{"resourceType":"APPLICATION","resourceId":"0oa9g0l878boNXWzs1d7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Campaign defined for applications with users as scope","description":"This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer."},"components/examples/campaigns-creatable-03-reviewer-with-users-expression":{"id":"components/examples/campaigns-creatable-03-reviewer-with-users-expression","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Campaign with reviewer scope expression","description":"The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression."},"components/examples/campaigns-creatable-04-notify-reviewer-at-campaign-end":{"id":"components/examples/campaigns-creatable-04-notify-reviewer-at-campaign-end","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"notificationSettings":{"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Campaign with reviewer notification at campaign end","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end."},"components/examples/campaigns-creatable-04-notify-reviewer-on-assignment":{"id":"components/examples/campaigns-creatable-04-notify-reviewer-on-assignment","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Campaign with reviewer notification at campaign assignment","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment."},"components/examples/campaigns-creatable-04-remind-reviewer-before-campaign-end":{"id":"components/examples/campaigns-creatable-04-remind-reviewer-before-campaign-end","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"notificationSettings":{"remindersReviewerBeforeCampaignCloseInSecs":[3600,86400,172800]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Campaign with reviewer reminders before campaign end","description":"The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end."},"components/examples/campaigns-creatable-05-remediation-as-remove-from-group-on-revoke":{"id":"components/examples/campaigns-creatable-05-remediation-as-remove-from-group-on-revoke","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"}},"summary":"Campaign with remediation to remove users from group on revoke","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer."},"components/examples/campaigns-creatable-05-remediation-as-remove-from-group-on-no-decision-from-reviewer":{"id":"components/examples/campaigns-creatable-05-remediation-as-remove-from-group-on-no-decision-from-reviewer","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"summary":"Campaign with remediation to remove users from group when no decision by reviewer","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer."},"components/examples/campaigns-creatable-06-recurring-every-month-on-5th-day":{"id":"components/examples/campaigns-creatable-06-recurring-every-month-on-5th-day","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"RECURRING","startDate":"2023-05-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P1M","repeatOnType":"SAME_DAY_AS_START_DATE"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"summary":"Recurring campaign that repeats every 5th day of the month","description":"A recurring campaign that repeats indefinitely every month on the 5th day."},"components/examples/campaigns-creatable-06-recurring-every-3-months-on-thursday-of-2nd-week-day":{"id":"components/examples/campaigns-creatable-06-recurring-every-3-months-on-thursday-of-2nd-week-day","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"RECURRING","startDate":"2023-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P3M","repeatOnType":"SAME_WEEKDAY_AS_START_DATE","ends":"2024-07-01T00:00:01.001Z"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"summary":"Recurring campaign that repeats every 3 months on Thursday of 2nd week","description":"A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date."},"components/examples/campaigns-creatable-07-reviewer-group-owner":{"id":"components/examples/campaigns-creatable-07-reviewer-group-owner","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"RESOURCE_OWNER","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"summary":"Campaign with reviewer group owner"},"components/examples/campaigns-creatable-07-reviewer-group":{"id":"components/examples/campaigns-creatable-07-reviewer-group","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"GROUP","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","reviewerGroupId":"irgw7zU9vHVj1ldKx0g2"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"summary":"Campaign with reviewer group"},"components/examples/campaigns-creatable-08-multi-level-reviewer-type-user":{"id":"components/examples/campaigns-creatable-08-multi-level-reviewer-type-user","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerId":"00u12gpFVIth5WbxT0g4","type":"USER","startReview":{"onDay":0}},{"reviewerId":"00u11knukTc2hYuTC0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"}}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Multi level campaign with reviewerType USER at both levels"},"components/examples/campaigns-creatable-08-multi-level-reviewer-type-group":{"id":"components/examples/campaigns-creatable-08-multi-level-reviewer-type-group","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerGroupId":"00g10ukkkcE7g2wvm0g5","type":"GROUP","startReview":{"onDay":0},"selfReviewDisabled":false},{"reviewerGroupId":"irg186ZIbgNfadsPb0g3","type":"GROUP","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":true}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Multi level campaign with reviewerType GROUP at both levels"},"components/examples/campaigns-creatable-08-multi-level-reviewer-type-group-owner-at-level1-and-user-at-level2":{"id":"components/examples/campaigns-creatable-08-multi-level-reviewer-type-group-owner-at-level1-and-user-at-level2","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"RESOURCE_OWNER","startReview":{"onDay":0},"selfReviewDisabled":true},{"reviewerId":"00u11knsq97GGflac0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER"},"components/examples/campaigns-creatable-09-user-centric-app-and-group":{"id":"components/examples/campaigns-creatable-09-user-centric-app-and-group","value":{"name":"Monthly access review of sales team","description":"Review access of certain users for all their apps and groups","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP"],"individuallyAssignedAppsOnly":false,"individuallyAssignedGroupsOnly":false},"principalScopeSettings":{"type":"USERS","userIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"User centric campaign with specific users and both apps and groups as resources"},"components/examples/campaigns-creatable-09-user-centric-excluded-resources":{"id":"components/examples/campaigns-creatable-09-user-centric-excluded-resources","value":{"name":"Monthly access review of sales team","description":"Review access of certain users for all their apps and groups except excluded resources","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00u12gpFVIth5WbxT0g4","resourceType":"GROUP"},{"resourceId":"00u11knukTc2hYuTC0g5","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","groupIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"User centric campaign with excluded resources"},"components/examples/campaigns-creatable-10-ramp-entitlements":{"id":"components/examples/campaigns-creatable-10-ramp-entitlements","value":{"name":"Monthly access review of sales team","description":"Review access of users assigned to apps and its entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementBundles":[{"id":"00gyqjxNrZD11n4w40g3"}],"entitlements":[{"id":"00ub0oNGTSWTBKOLGLNR","includeAllValues":false,"values":[{"id":"entfxqCAJWWGELFTYAAA"},{"id":"00u12gpFVIth5WbxT0g4"}]}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign on application with entitlements and bundles","description":"Applicable when the application has ramp entitlements such as Salesforce or Google.\n"},"components/examples/campaigns-creatable-11-resource-centric-admin-roles":{"id":"components/examples/campaigns-creatable-11-resource-centric-admin-roles","value":{"name":"Review of admin roles","description":"Review all users with an Okta admin role","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"0oa33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":true},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":true,"justificationRequired":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign on Okta Admin Console","description":"The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n"},"components/examples/campaigns-creatable-12-predefined-scope":{"id":"components/examples/campaigns-creatable-12-predefined-scope","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"},{"resourceId":"00ayqjxNrZD11n4w40g4"}]},"principalScopeSettings":{"type":"USERS","predefinedInactiveUsersScope":{"inactiveDays":90}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Campaign defined for applications with predefined inactive users scope","description":"The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications."},"components/examples/campaigns-creatable-13-multiapp":{"id":"components/examples/campaigns-creatable-13-multiapp","value":{"name":"Aug 1 - Multi App Campaign","description":"Multi app campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-08-01T10:08:36-07:00","durationInDays":21,"timeZone":"America/Vancouver"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceId":"0oa1d00gtLNtrDEiz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true},{"resourceId":"0oa17a5l4ZgcHbvoz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Multi App Entitlement Campaign","description":"The set of properties received when creating a resource-centric multi app entitlement campaign"},"components/examples/campaigns-creatable-14-groups-auto-remediated":{"id":"components/examples/campaigns-creatable-14-groups-auto-remediated","value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"},{"resourceId":"00ayqjxNrZD11n4w40g4"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","reassignmentDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY","autoRemediationSettings":{"includeAllIndirectAssignments":false,"includeOnly":[{"type":"GROUP","id":"00gyqjxNrsh764hjs784"},{"type":"GROUP","id":"00glupyvtjRjiYehQ0g4"}]}}},"summary":"Campaign defined for applications with group remediation settings","description":"The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated."},"components/examples/campaigns-creatable-15-sod-multi-user-entitlement":{"id":"components/examples/campaigns-creatable-15-sod-multi-user-entitlement","value":{"campaignType":"RESOURCE","description":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","name":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","scheduleSettings":{"startDate":"2025-03-17T17:20:09.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"onlyIncludeUsersWithSODConflicts":true,"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"bulkDecisionDisabled":true,"reviewerLevels":[{"reviewerId":"00u8emkyb56SK6NNE0g7","startReview":{"onDay":0},"type":"USER"},{"reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":false,"startReview":{"when":"LOWER_LEVEL_APPROVES","onDay":15},"type":"GROUP"}],"justificationRequired":true,"type":"MULTI_LEVEL"},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"SOD campaign with multi-level user and group reviewers"},"components/examples/campaigns-creatable-16-sod-manager-expression-showall":{"id":"components/examples/campaigns-creatable-16-sod-manager-expression-showall","value":{"campaignType":"RESOURCE","description":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","name":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","scheduleSettings":{"startDate":"2025-03-17T17:20:20.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"onlyIncludeUsersWithSODConflicts":false,"userScopeExpression":"user.profile.department==\"Purchasing\" || user.profile.department==\"IT\"","type":"USERS"},"reviewerSettings":{"reviewerScopeExpression":"user.profile.managerId","selfReviewDisabled":true,"justificationRequired":false,"fallBackReviewerId":"00u8emkyb56SK6NNE0g7","type":"REVIEWER_EXPRESSION","bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"SOD campaign to show all users with a manager reviewer"},"components/examples/campaigns-creatable-16-sod-manager-realm-expression-showconflicts":{"id":"components/examples/campaigns-creatable-16-sod-manager-realm-expression-showconflicts","value":{"campaignType":"RESOURCE","description":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","name":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","scheduleSettings":{"startDate":"2025-03-17T17:48:16.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"userScopeExpression":"user.realmId==\"guo8emlxtsLOx3Q1H0g7\"","type":"USERS","onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"reviewerScopeExpression":"user.profile.managerId","selfReviewDisabled":true,"justificationRequired":false,"fallBackReviewerId":"00u8emkyb56SK6NNE0g7","type":"REVIEWER_EXPRESSION","bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"SOD campaign to show only conflicts with a realm expression and a manager reviewer"},"components/examples/campaigns-creatable-17-sod-group-showconflicts":{"id":"components/examples/campaigns-creatable-17-sod-group-showconflicts","value":{"campaignType":"RESOURCE","description":"App SOD Campaign | Group Reviewer | Entitlements","name":"App SOD Campaign | Group Reviewer | Entitlements","status":"ACTIVE","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":true},"principalScopeSettings":{"type":"USERS","onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true,"reviewerGroupId":"00g8eubpdlXjtVkql0g7","type":"GROUP"},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"SOD campaign to show only conflicts with entitlements and a group reviewer"},"components/examples/campaigns-creatable-17-sod-group-expression-showconflicts":{"id":"components/examples/campaigns-creatable-17-sod-group-expression-showconflicts","value":{"campaignType":"RESOURCE","description":"App SOD Campaign | Group Reviewer | User Expression | Entitlements","name":"App SOD Campaign | Group Reviewer | User Expression Entitlements","scheduleSettings":{"startDate":"2025-03-17T18:43:57.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.department == \"Purchasing\" || user.profile.department == \"IT\"","onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true,"reviewerGroupId":"00g8eubpdlXjtVkql0g7","type":"GROUP"},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer"},"components/examples/campaigns-creatable-18-governance-labels-scope-apps":{"id":"components/examples/campaigns-creatable-18-governance-labels-scope-apps","value":{"campaignType":"RESOURCE","description":"App Campaign | Governance Label Values","name":"App Campaign | Governance Label Values","status":"ACTIVE","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":false,"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Governance campaign with targeted apps through governance label values"},"components/examples/campaigns-creatable-19-governance-labels-scope-groups":{"id":"components/examples/campaigns-creatable-19-governance-labels-scope-groups","value":{"campaignType":"RESOURCE","description":"Group Campaign | Governance Label Values","name":"Group Campaign | Governance Label Values","status":"ACTIVE","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Governance campaign that targets groups through governance label values"},"components/examples/campaigns-creatable-20-governance-labels-scope-entitlements-by-labels":{"id":"components/examples/campaigns-creatable-20-governance-labels-scope-entitlements-by-labels","value":{"name":"Entitlement Campaign | Governance Label Values","description":"Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign on an app with entitlements and bundles that are targeted through governance labels"},"components/examples/campaigns-creatable-21-governance-labels-scope-apps-and-entitlements-by-labels":{"id":"components/examples/campaigns-creatable-21-governance-labels-scope-apps-and-entitlements-by-labels","value":{"name":"Application Entitlement Campaign | Governance Label Values","description":"Application Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign on apps with entitlements and bundles that are all targeted through governance labels"},"components/examples/campaigns-creatable-22-okta-service-accounts":{"id":"components/examples/campaigns-creatable-22-okta-service-accounts","value":{"name":"Okta Service Account Campaign","description":"Okta Service Account Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["OKTA_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"19a2c9b1-78a0-4bf0-be9a-c064dd1eba3f","resourceType":"OKTA_SERVICE_ACCOUNT"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign certifying Okta service accounts"},"components/examples/campaigns-creatable-23-app-service-accounts":{"id":"components/examples/campaigns-creatable-23-app-service-accounts","value":{"name":"Application Service Accounts Campaign","description":"Application Service Accounts Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APP_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllAppServiceAccounts":false,"appServiceAccounts":[{"id":"98318fba-cff5-4394-b67c-2774b3980aec"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign certifying SaaS app service accounts"},"components/examples/campaigns-creatable-24-collection":{"id":"components/examples/campaigns-creatable-24-collection","value":{"name":"Collection Campaign","description":"Collection Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"col2v7TA5ecDXIvhL0g3","resourceType":"COLLECTION"},{"resourceId":"col2w4CdEIDVHTA4L0g3","resourceType":"COLLECTION"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign certifying collections"},"components/examples/campaigns-creatable-25-governance-label-value":{"id":"components/examples/campaigns-creatable-25-governance-label-value","value":{"name":"Collection Campaign with Governance Label Values","description":"Collection Campaign with Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"lblm6vmyH0RQz9f5k0g4","resourceType":"GOVERNANCE_LABEL_VALUE"},{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign certifying collections using governance label values"},"components/examples/campaigns-creatable-26-user-centric-include-collections":{"id":"components/examples/campaigns-creatable-26-user-centric-include-collections","value":{"name":"Monthly access review of sales team","description":"Review access of certain users to all their apps, groups, and collections.","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP","COLLECTION"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00u12gpFVIth5WbxT0g4","resourceType":"GROUP"},{"resourceId":"00u11knukTc2hYuTC0g5","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","groupIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"User centric campaign that includes collection resources"},"components/examples/campaigns-creatable-27-justification-requirement":{"id":"components/examples/campaigns-creatable-27-justification-requirement","value":{"campaignType":"RESOURCE","description":"Group Campaign | Justification Required For All","name":"Group Campaign | Justification Required For All","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T13:43:40.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GROUP","resourceId":"00gg2gzn7m1Aw2zAs1d7"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequirement":"REQUIRED_FOR_ALL","type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"},"reportingSettings":{"createReportingPackageEnabled":true}},"summary":"Campaign with justification requirement"},"components/examples/campaigns-creatable-28-ai-agent-resource-connection":{"id":"components/examples/campaigns-creatable-28-ai-agent-resource-connection","value":{"name":"Monthly access review of AI agent connections","description":"Review access of certain AI agents to all their connected resources.","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["AI_AGENT_CONNECTION"],"individuallyAssignedAppsOnly":false,"individuallyAssignedGroupsOnly":false,"excludedResources":[]},"principalScopeSettings":{"type":"AI_AGENTS","aiAgentIds":["wlpx9jQ16k9V8IFEL0g3","wlpx8kR27j0U7HGDM1h4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"summary":"Campaign certifying AI agents' connected resources"},"components/examples/campaigns-creatable-response-01-group-with-user-scope":{"id":"components/examples/campaigns-creatable-response-01-group-with-user-scope","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/launch","hints":{}},"endCampaign":{"href":"https:///myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/end","hints":{}},"reviews":{"href":"https:///myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindtwi8SY3MVP1M1d6%22","hints":{}},"self":{"href":"https:///myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6","hints":{}}},"id":"icindtwi8SY3MVP1M1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T13:43:35Z","lastUpdated":"2024-10-04T13:43:35Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"Group Campaign | User Reviewer Expression","description":"Group Campaign | User Reviewer Expression","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T09:43:40-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T08:43:40-05:00"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gg2gzn7m1Aw2zAs1d7","resourceType":"GROUP","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.reviewerId","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"Campaign with a group with users as scope","description":"The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used."},"components/examples/campaigns-creatable-response-01-group-with-user-expression-scope":{"id":"components/examples/campaigns-creatable-response-01-group-with-user-expression-scope","value":{"_links":{"launchCampaign":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/campaigns/icindsflgKOT1IpJJ1d6/launch","hints":{}},"endCampaign":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/campaigns/icindsflgKOT1IpJJ1d6/end","hints":{}},"reviews":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindsflgKOT1IpJJ1d6%22","hints":{}},"self":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/campaigns/icindsflgKOT1IpJJ1d6","hints":{}}},"id":"icindsflgKOT1IpJJ1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T13:37:43Z","lastUpdated":"2024-10-04T13:37:43Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"Group Campaign | User Reviewer Expression | User Expression","description":"Group Campaign | User Reviewer Expression | User Expression","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T09:37:47-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T08:37:47-05:00"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gg2gzn7m1Aw2zAs1d7","resourceType":"GROUP","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.title==\"Engineer\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.reviewerId","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"Campaign with a group with user expression scope","description":"The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group."},"components/examples/campaigns-creatable-response-02-app-with-users-scope":{"id":"components/examples/campaigns-creatable-response-02-app-with-users-scope","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindto3sXIqOrZla1d6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindto3sXIqOrZla1d6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindto3sXIqOrZla1d6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindto3sXIqOrZla1d6","hints":{}}},"id":"icindto3sXIqOrZla1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T14:15:19Z","lastUpdated":"2024-10-04T14:15:19Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"App Campaign | User Reviewer | Without Entitlements","description":"App Campaign | User Reviewer | Without Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T10:15:23-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T09:15:23-05:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa9g0l878boNXWzs1d7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"Campaign with an app with users as scope","description":"The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer."},"components/examples/campaigns-creatable-response-03-reviewer-with-reviewer-id":{"id":"components/examples/campaigns-creatable-response-03-reviewer-with-reviewer-id","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with reviewer ID","description":"The set of properties to pass when creating a campaign with reviewer settings and reviewer Id."},"components/examples/campaigns-creatable-response-03-reviewer-with-users-expression":{"id":"components/examples/campaigns-creatable-response-03-reviewer-with-users-expression","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with reviewer scope expression","description":"The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression."},"components/examples/campaigns-creatable-response-04-notify-reviewer-at-campaign-end":{"id":"components/examples/campaigns-creatable-response-04-notify-reviewer-at-campaign-end","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"notificationSettings":{"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with reviewer notification at campaign end","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end."},"components/examples/campaigns-creatable-response-04-notify-reviewer-on-assignment":{"id":"components/examples/campaigns-creatable-response-04-notify-reviewer-on-assignment","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with reviewer notification at campaign assignment","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment."},"components/examples/campaigns-creatable-response-04-remind-reviewer-before-campaign-end":{"id":"components/examples/campaigns-creatable-response-04-remind-reviewer-before-campaign-end","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"notificationSettings":{"remindersReviewerBeforeCampaignEndInSecs":[3600,600,60]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with reviewer reminders before campaign end","description":"The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end."},"components/examples/campaigns-creatable-response-05-remediation-as-remove-from-group-on-revoke":{"id":"components/examples/campaigns-creatable-response-05-remediation-as-remove-from-group-on-revoke","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with remediation to remove users from group on revoke","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer."},"components/examples/campaigns-creatable-response-05-remediation-as-remove-from-group-on-no-decision-from-reviewer":{"id":"components/examples/campaigns-creatable-response-05-remediation-as-remove-from-group-on-no-decision-from-reviewer","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with remediation to remove users from group when no decision by reviewer","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer."},"components/examples/campaigns-creatable-response-06-recurring-campaign-every-month-on-5th-day":{"id":"components/examples/campaigns-creatable-response-06-recurring-campaign-every-month-on-5th-day","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"RECURRING","startDate":"2023-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P1M","repeatOnType":"SAME_DAY_AS_START_DATE"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"title":"For recurring campaign, this will provide a new campaign resource endpoint in the \"Location\" header","href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Recurring campaign repeating indefinitely on 30th day of every month","description":"A recurring campaign that repeats indefinitely every month on the 30th day."},"components/examples/campaigns-creatable-response-06-recurring-campaign-every-3-months-on-thursday-of-2nd-week":{"id":"components/examples/campaigns-creatable-response-06-recurring-campaign-every-3-months-on-thursday-of-2nd-week","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"RECURRING","startDate":"2023-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P3M","repeatOn":"SAME_WEEKDAY_AS_START_DATE","ends":"2024-07-01T00:00:01.001Z"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"title":"For recurring campaign, this will provide a new campaign resource endpoint in the \"Location\" header","href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Recurring campaign that repeats every 3 months on Thursday of 2nd week","description":"A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date."},"components/examples/campaigns-creatable-response-07-reviewer-group-owner":{"id":"components/examples/campaigns-creatable-response-07-reviewer-group-owner","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"RESOURCE_OWNER","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with group owners"},"components/examples/campaigns-creatable-response-07-reviewer-group":{"id":"components/examples/campaigns-creatable-response-07-reviewer-group","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"irgw7zU9vHVj1ldKx0g2","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with reviewer group"},"components/examples/campaigns-creatable-response-08-multilevel-reviewerType-user-at-both-levels":{"id":"components/examples/campaigns-creatable-response-08-multilevel-reviewerType-user-at-both-levels","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerId":"00u12gpFVIth5WbxT0g4","type":"USER","startReview":{"onDay":0},"selfReviewDisabled":false},{"reviewerId":"00u11knukTc2hYuTC0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign of multi level type with reviewerType USER at both levels"},"components/examples/campaigns-creatable-response-08-multilevel-reviewerType-group-at-both-levels":{"id":"components/examples/campaigns-creatable-response-08-multilevel-reviewerType-group-at-both-levels","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerGroupId":"00g10ukkkcE7g2wvm0g5","fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"GROUP","startReview":{"onDay":0},"selfReviewDisabled":false},{"reviewerGroupId":"irg186ZIbgNfadsPb0g3","fallBackReviewerId":"00u11knsq97GGflac0g5","type":"GROUP","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":true}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign of multi level type with reviewerType GROUP at both levels"},"components/examples/campaigns-creatable-response-08-multilevel-reviewerType-group-owner-at-level1-and-user-at-level2":{"id":"components/examples/campaigns-creatable-response-08-multilevel-reviewerType-group-owner-at-level1-and-user-at-level2","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"RESOURCE_OWNER","startReview":{"onDay":0},"selfReviewDisabled":true},{"reviewerId":"00u11knsq97GGflac0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES_OR_REJECTS"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2"},"components/examples/campaigns-creatable-response-09-user-centric-app-group":{"id":"components/examples/campaigns-creatable-response-09-user-centric-app-group","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to all their apps and groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with user centric and apps and groups as resources","description":"The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users."},"components/examples/campaigns-creatable-response-09-user-centric-excluded-resources":{"id":"components/examples/campaigns-creatable-response-09-user-centric-excluded-resources","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00g1rv27u2TF9nhTw0g4","resourceType":"GROUP"},{"resourceId":"00g1rv4XS9W3Kpdqr0g4","resourceType":"GROUP"},{"resourceId":"0oa15kjDgk1EubTwo0g4","resourceType":"APPLICATION"},{"resourceId":"0oa15kacS7yNOcBoU0g4","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign user centric with excluded users","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"components/examples/campaigns-creatable-response-10-ramp-entitlement-enabled-apps":{"id":"components/examples/campaigns-creatable-response-10-ramp-entitlement-enabled-apps","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementBundles":[{"id":"00gyqjxNrZD11n4w40g3"}],"entitlements":[{"id":"00ub0oNGTSWTBKOLGLNR","includeAllValues":false,"values":[{"id":"entfxqCAJWWGELFTYAAA"},{"id":"00u12gpFVIth5WbxT0g4"}]}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign on application with entitlements and bundles","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"components/examples/campaigns-creatable-response-11-resource-centric-admin-roles":{"id":"components/examples/campaigns-creatable-response-11-resource-centric-admin-roles","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Review of admin roles","description":"Review all users with an Okta admin role","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"RESOURCE","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"0oa33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":true,"justificationRequired":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign on Okta Admin Console","description":"The set of properties received when creating a resource-centric campaign on the Okta Admin Console."},"components/examples/campaigns-creatable-response-12-predefined-inactive-users":{"id":"components/examples/campaigns-creatable-response-12-predefined-inactive-users","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"}]},"principalScopeSettings":{"type":"USERS","predefinedInactiveUsersScope":{"inactiveDays":90}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with a app and predefined inactive users scope","description":"The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days."},"components/examples/campaigns-creatable-response-13-multiapp":{"id":"components/examples/campaigns-creatable-response-13-multiapp","value":{"id":"ici4dny7lnWXs8oRr8g6","createdBy":"00u29i85Lay3jSRlw8g5","created":"2024-08-01T17:08:36Z","lastUpdated":"2024-08-01T17:08:54Z","lastUpdatedBy":"00u29i85Lay3jSRlw8g5","name":"Aug 1 - Multi App Campaign","description":"Multi app campaign","campaignType":"RESOURCE","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-08-01T10:08:36-07:00","durationInDays":21,"timeZone":"America/Vancouver","endDate":"2024-08-22T10:08:36-07:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa1d00gtLNtrDEiz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true},{"resourceId":"0oa17a5l4ZgcHbvoz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/campaigns/ici4dny7lnWXs8oRr8g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/campaigns/ici4dny7lnWXs8oRr8g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici4dny7lnWXs8oRr8g6%22","hints":{}},"self":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/campaigns/ici4dny7lnWXs8oRr8g6","hints":{}}}},"summary":"Multi App Entitlement Campaign","description":"The set of properties received when creating a resource-centric multi app entitlement campaign"},"components/examples/campaigns-creatable-response-14-groups-auto-remediated":{"id":"components/examples/campaigns-creatable-response-14-groups-auto-remediated","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY","autoRemediationSettings":{"includeAllIndirectAssignments":false,"includeOnly":[{"type":"GROUP","id":"00gyqjxNrsh764hjs784"},{"type":"GROUP","id":"00glupyvtjRjiYehQ0g4"}]}},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with an app and group remediation settings","description":"The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated."},"components/examples/campaigns-creatable-response-15-sod-multi-user-entitlement":{"id":"components/examples/campaigns-creatable-response-15-sod-multi-user-entitlement","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdjwBUjRCEsC0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdjwBUjRCEsC0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mdjwBUjRCEsC0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdjwBUjRCEsC0g6","hints":{}}},"id":"icib9mdjwBUjRCEsC0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:20:05Z","lastUpdated":"2025-03-17T17:20:05Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","description":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:20:09-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:20:09-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":false},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"type":"USER","startReview":{"onDay":0},"reviewerId":"00u8emkyb56SK6NNE0g7","selfReviewDisabled":false},{"type":"GROUP","startReview":{"onDay":15,"when":"LOWER_LEVEL_APPROVES"},"reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":false}]},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"SOD campaign with multi-level user and group reviewers"},"components/examples/campaigns-creatable-response-16-sod-manager-expression-showall":{"id":"components/examples/campaigns-creatable-response-16-sod-manager-expression-showall","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdlvqVT9YzkZ0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdlvqVT9YzkZ0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mdlvqVT9YzkZ0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdlvqVT9YzkZ0g6","hints":{}}},"id":"icib9mdlvqVT9YzkZ0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:20:15Z","lastUpdated":"2025-03-17T17:20:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","description":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:20:20-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:20:20-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.department==\"Purchasing\" || user.profile.department==\"IT\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":false},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00u8emkyb56SK6NNE0g7","selfReviewDisabled":true,"justificationRequired":false,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"SOD campaign to show all users with a manager reviewer"},"components/examples/campaigns-creatable-response-16-sod-manager-realm-expression-showconflicts":{"id":"components/examples/campaigns-creatable-response-16-sod-manager-realm-expression-showconflicts","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9md6vsfZyE7qR0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9md6vsfZyE7qR0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9md6vsfZyE7qR0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9md6vsfZyE7qR0g6","hints":{}}},"id":"icib9md6vsfZyE7qR0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:48:12Z","lastUpdated":"2025-03-17T17:48:12Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","description":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:48:16-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:48:16-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.realmId==\"guo8emlxtsLOx3Q1H0g7\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00u8emkyb56SK6NNE0g7","selfReviewDisabled":true,"justificationRequired":false,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"SOD campaign to show only conflicts with a realm expression and a manager reviewer"},"components/examples/campaigns-creatable-response-17-sod-group-showconflicts":{"id":"components/examples/campaigns-creatable-response-17-sod-group-showconflicts","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign | Group Reviewer | Entitlements","description":"App SOD Campaign | Group Reviewer | Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:56:19-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:56:19-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"SOD campaign to show only conflicts with entitlements and a group reviewer"},"components/examples/campaigns-creatable-response-17-sod-group-expression-showconflicts":{"id":"components/examples/campaigns-creatable-response-17-sod-group-expression-showconflicts","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9n9u1nXwN9PCd0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9n9u1nXwN9PCd0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9n9u1nXwN9PCd0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9n9u1nXwN9PCd0g6","hints":{}}},"id":"icib9n9u1nXwN9PCd0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T18:43:52Z","lastUpdated":"2025-03-17T18:43:52Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign | Group Reviewer | User Expression Entitlements","description":"App SOD Campaign | Group Reviewer | User Expression Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T14:43:57-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T14:43:57-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.department == \"Purchasing\" || user.profile.department == \"IT\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer"},"components/examples/campaigns-creatable-response-18-governance-labels-scope-apps":{"id":"components/examples/campaigns-creatable-response-18-governance-labels-scope-apps","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","campaignType":"RESOURCE","description":"App Campaign | Governance Label Values","name":"App Campaign | Governance Label Values","status":"SCHEDULED","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":false,"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Governance campaign with targeted apps through governance label values"},"components/examples/campaigns-creatable-response-19-governance-labels-scope-groups":{"id":"components/examples/campaigns-creatable-response-19-governance-labels-scope-groups","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","campaignType":"RESOURCE","description":"Group Campaign | Governance Label Values","name":"Group Campaign | Governance Label Values","status":"SCHEDULED","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"summary":"Governance campaign that targets groups through governance label values"},"components/examples/campaigns-creatable-response-20-governance-labels-scope-entitlements-by-labels":{"id":"components/examples/campaigns-creatable-response-20-governance-labels-scope-entitlements-by-labels","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Entitlement Campaign | Governance Label Values","description":"Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"summary":"Campaign on an app with entitlements and bundles that are targeted through governance labels"},"components/examples/campaigns-creatable-response-21-governance-labels-scope-apps-and-entitlements-by-labels":{"id":"components/examples/campaigns-creatable-response-21-governance-labels-scope-apps-and-entitlements-by-labels","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Application Entitlement Campaign | Governance Label Values","description":"Application Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"summary":"Campaign on apps with entitlements and bundles that are all targeted through governance labels"},"components/examples/campaigns-creatable-response-22-okta-service-accounts":{"id":"components/examples/campaigns-creatable-response-22-okta-service-accounts","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Okta Service Acccount Campaign","description":"Okta Service Acccount Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["OKTA_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"19a2c9b1-78a0-4bf0-be9a-c064dd1eba3f","resourceType":"OKTA_SERVICE_ACCOUNT"}],"includeAllOktaServiceAccounts":false},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"summary":"Campaign certifying Okta service accounts"},"components/examples/campaigns-creatable-response-23-app-service-accounts":{"id":"components/examples/campaigns-creatable-response-23-app-service-accounts","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App Service Acccount Campaign","description":"App Service Acccount Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APP_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllAppServiceAccounts":false,"appServiceAccounts":[{"id":"98318fba-cff5-4394-b67c-2774b3980aec"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"summary":"Campaign certifying SaaS app service accounts"},"components/examples/campaigns-creatable-response-24-collection":{"id":"components/examples/campaigns-creatable-response-24-collection","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2024-10-04T13:43:40Z","lastUpdated":"2024-10-04T13:43:40Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Collection Campaign","description":"Collection Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"col2v7TA5ecDXIvhL0g3","resourceType":"COLLECTION"},{"resourceId":"col2w4CdEIDVHTA4L0g3","resourceType":"COLLECTION"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"summary":"Campaign certifying collections"},"components/examples/campaigns-creatable-response-25-governance-label-value":{"id":"components/examples/campaigns-creatable-response-25-governance-label-value","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2024-10-04T13:43:40Z","lastUpdated":"2024-10-04T13:43:40Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Collection Campaign with Governance Label Values","description":"Collection Campaign with Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"lblm6vmyH0RQz9f5k0g4","resourceType":"GOVERNANCE_LABEL_VALUE"},{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"summary":"Campaign certifying collections using governance label values"},"components/examples/campaigns-creatable-response-26-user-centric-include-collections":{"id":"components/examples/campaigns-creatable-response-26-user-centric-include-collections","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP","COLLECTION"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00u12gpFVIth5WbxT0g4","resourceType":"GROUP"},{"resourceId":"00u11knukTc2hYuTC0g5","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","groupIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"User centric campaign that includes collection resources"},"components/examples/campaigns-creatable-response-27-justification-requirement":{"id":"components/examples/campaigns-creatable-response-27-justification-requirement","value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindtwi8SY3MVP1M1d6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6","hints":{}}},"id":"icindtwi8SY3MVP1M1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T13:43:35Z","lastUpdated":"2024-10-04T13:43:35Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"Group Campaign | Justification Required For All","description":"Group Campaign | Justification Required For All","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T09:43:40-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T08:43:40-05:00"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gg2gzn7m1Aw2zAs1d7","resourceType":"GROUP","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"justificationRequirement":"REQUIRED_FOR_ALL","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"summary":"Campaign with justification requirement"},"components/examples/campaigns-creatable-response-28-ai-agent-resource-connection":{"id":"components/examples/campaigns-creatable-response-28-ai-agent-resource-connection","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of AI agent connections","description":"Review access of certain AI agents to all their connected resources.","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["AI_AGENT_CONNECTION"],"individuallyAssignedAppsOnly":false,"individuallyAssignedGroupsOnly":false,"excludedResources":[]},"principalScopeSettings":{"type":"AI_AGENTS","aiAgentIds":["wlpx9jQ16k9V8IFEL0g3","wlpx8kR27j0U7HGDM1h4"],"excludedUserIds":[]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign certifying AI agents' connected resources"},"components/examples/campaigns-get-response-01-scheduled-campaign":{"id":"components/examples/campaigns-get-response-01-scheduled-campaign","value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"SCHEDULED","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Get campaign by id that is in scheduled state.","description":"Get the campaign by Id that is in scheduled state"},"components/examples/campaigns-get-response-01-launching-campaign":{"id":"components/examples/campaigns-get-response-01-launching-campaign","value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"LAUNCHING","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Get campaign by id that is in launching state.","description":"Get the campaign by Id that is in launching state"},"components/examples/campaigns-get-response-01-errored-campaign":{"id":"components/examples/campaigns-get-response-01-errored-campaign","value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"ERROR","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Get campaign by id that is in error state.","description":"Get the campaign by Id that is in error state."},"components/examples/campaigns-get-response-02-recurring-campaign":{"id":"components/examples/campaigns-get-response-02-recurring-campaign","value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"SCHEDULED","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"RECURRING","startDate":"2023-06-01T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P1M","repeatOnType":"SAME_WEEKDAY_AS_START_DATE"}},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Get recurring campaign details in scheduled state.","description":"Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule."},"components/examples/campaigns-get-response-02-launched-recurring-campaign-instance":{"id":"components/examples/campaigns-get-response-02-launched-recurring-campaign-instance","value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"summary":"Get the launched recurring campaign instance.","description":"Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually."},"components/examples/campaigns-get-response-03-with-group-owner":{"id":"components/examples/campaigns-get-response-03-with-group-owner","value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"RESOURCE_OWNER","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"summary":"Get the campaign with group owners as reviewers","description":"Returns a campaign containing reviewers as owners of the groups under reviewer"},"components/examples/campaigns-get-response-03-with-reviewer-group":{"id":"components/examples/campaigns-get-response-03-with-reviewer-group","value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"irgw7zU9vHVj1ldKx0g2","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"summary":"Get the campaign with reviewer group","description":"Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign."},"components/examples/campaigns-get-response-03-with-multi-level":{"id":"components/examples/campaigns-get-response-03-with-multi-level","value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerGroupId":"00g10ukkkcE7g2wvm0g5","fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"GROUP","startReview":{"onDay":0}},{"reviewerId":"00u11knsq97GGflac0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"summary":"Get the campaign of multi level","description":"Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision."},"components/examples/campaigns-get-response-04-user-centric-app-group":{"id":"components/examples/campaigns-get-response-04-user-centric-app-group","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to all their apps and groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"APPLICATION_AND_GROUP","individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with user centric and apps and groups as resources","description":"The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users."},"components/examples/campaigns-get-response-04-user-centric-excluded-resources":{"id":"components/examples/campaigns-get-response-04-user-centric-excluded-resources","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00g1rv27u2TF9nhTw0g4","resourceType":"GROUP"},{"resourceId":"00g1rv4XS9W3Kpdqr0g4","resourceType":"GROUP"},{"resourceId":"0oa15kjDgk1EubTwo0g4","resourceType":"APPLICATION"},{"resourceId":"0oa15kacS7yNOcBoU0g4","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign user centric with excluded users","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"components/examples/campaigns-get-response-05-ramp-entitlement-enabled-apps":{"id":"components/examples/campaigns-get-response-05-ramp-entitlement-enabled-apps","value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"APPLICATION","includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementBundles":[{"id":"00gyqjxNrZD11n4w40g3"}],"entitlements":[{"id":"00ub0oNGTSWTBKOLGLNR","includeAllValues":false,"values":[{"id":"entfxqCAJWWGELFTYAAA"},{"id":"00u12gpFVIth5WbxT0g4"}]}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"summary":"Campaign with ramp entitlements enabled","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"components/examples/reviews-list-response-01-filtered-by-campaignId":{"id":"components/examples/reviews-list-response-01-filtered-by-campaignId","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22icitdyhndQ6qstyvR8g5%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22icitdyhndQ6qstyvR8g5%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after%3D1"}}},"summary":"List of reviews filtered by campaignId","description":"The list of reviews that belong to that campaign."},"components/examples/reviews-list-response-01-filtered-by-decision":{"id":"components/examples/reviews-list-response-01-filtered-by-decision","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3Ddecision%20eq%20%22UNREVIEWED%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3Ddecision%20eq%20%22UNREVIEWED%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3Ddecision%20eq%20%22UNREVIEWED%22"}}},"summary":"List of reviews filtered by decision made"},"components/examples/reviews-list-response-01-filtered-by-principalId":{"id":"components/examples/reviews-list-response-01-filtered-by-principalId","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"REVOKE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DprincipalId%20eq%20%2200u28w6vzKKultXP98g5%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DprincipalId%20eq%20%2200u28w6vzKKultXP98g5%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DprincipalId%20eq%20%2200u28w6vzKKultXP98g5%22"}}},"summary":"List of reviews filtered by the principal ID","description":"The list of access reviews for a specific user (the principal)"},"components/examples/reviews-list-response-01-filtered-by-resourceId":{"id":"components/examples/reviews-list-response-01-filtered-by-resourceId","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DresourceId%20eq%20%2200gco5q3vQ20oPncs8g5%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DresourceId%20eq%20%2200gco5q3vQ20oPncs8g5%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DresourceId%20eq%20%2200gco5q3vQ20oPncs8g5%22"}}},"summary":"List of reviews filtered by resource ID"},"components/examples/reviews-list-response-01-filtered-by-reviewerId":{"id":"components/examples/reviews-list-response-01-filtered-by-reviewerId","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerId%20eq%20%2200u5v5viPvg84h0W68g4%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerId%20eq%20%2200u5v5viPvg84h0W68g4%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerId%20eq%20%2200u5v5viPvg84h0W68g4%22"}}},"summary":"List of reviews filtered by reviewer ID","description":"The list of reviews that are assigned to a specific reviewer."},"components/examples/reviews-list-response-01-filtered-by-reviewerType":{"id":"components/examples/reviews-list-response-01-filtered-by-reviewerType","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerGroupProfile":{"name":"Dev ops admins","groupId":"00gw7zU9vHVj1ldKx0g2","groupType":"GROUP"},"reviewerType":"GROUP","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerType%20eq%20%22GROUP%22"}}},"summary":"List of reviews filtered by reviewerType","description":"The list of reviews that are mapped to specific reviewer type."},"components/examples/reviews-list-response-01-filtered-by-reviewerLevel":{"id":"components/examples/reviews-list-response-01-filtered-by-reviewerLevel","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"RESOURCE_OWNER","reviewerGroupProfile":{"name":"Dev ops owners","groupId":"00gco5q3vQ20oPncs8g5","groupType":"RESOURCE_OWNER"},"currentReviewerLevel":"FIRST","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerType%20eq%20%22GROUP%22"}}},"summary":"List of reviews filtered by reviewerLevel"},"components/examples/reviews-list-response-02-filtered-by-entitlement-bundleid":{"id":"components/examples/reviews-list-response-02-filtered-by-entitlement-bundleid","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"entitlementBundle":{"id":"ebnb0oNGTSWTBKOLGLNR","name":"Entitlement bundle Name"},"decision":"APPROVE","remediationStatus":"NONE","reviewerGroupProfile":{"name":"Dev ops admins","groupId":"00gw7zU9vHVj1ldKx0g2","groupType":"GROUP"},"reviewerType":"GROUP","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerType%20eq%20%22GROUP%22"}}},"summary":"List of reviews filtered by reviewerType","description":"The list of reviews that are mapped to specific reviewer type."},"components/examples/reviews-list-response-02-filtered-by-entitlement-valueid":{"id":"components/examples/reviews-list-response-02-filtered-by-entitlement-valueid","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"entitlementValue":{"id":"entb0oNGTSWTBKOLGLNR","name":"Admin access","externalValue":"admin","entitlement":{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role"}},"decision":"APPROVE","remediationStatus":"NONE","reviewerGroupProfile":{"name":"Dev ops admins","groupId":"00gw7zU9vHVj1ldKx0g2","groupType":"GROUP"},"reviewerType":"GROUP","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerType%20eq%20%22GROUP%22"}}},"summary":"List of reviews filtered by entitlement value ID","description":"The list of reviews that are mapped to a specific entitlement value ID"},"components/examples/reassign-reviews-response-response-01-with-note":{"id":"components/examples/reassign-reviews-response-response-01-with-note","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u2iudyie873","email":"tal.gupta@example.com.com","firstName":"Tal","lastName":"Gupta","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhew4DFTxygUUgE0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhew4DFTxygUUgE0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00847dfjhgd98","email":"juan.garcia@example.com","firstName":"Juan","lastName":"Garcia","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhfvRCfGCHk3y2h0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhfvRCfGCHk3y2h0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/61eb2db568c7c300079fefd0/reviews/reassign"}}},"summary":"List of reviews after reassigning to a new reviewer","description":"The list of reviews that are reassigned."},"components/examples/reassign-reviews-response-response-02-from-reviewer-group":{"id":"components/examples/reassign-reviews-response-response-02-from-reviewer-group","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u2iudyie873","email":"tal.gupta@example.com","firstName":"Tal","lastName":"Gupta","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhew4DFTxygUUgE0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhew4DFTxygUUgE0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00847dfjhgd98","email":"juan.garcia@example.com","firstName":"Juan","lastName":"Garcia","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhfvRCfGCHk3y2h0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhfvRCfGCHk3y2h0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/61eb2db568c7c300079fefd0/reviews/reassign"}}},"summary":"List of reviews that were originally assigned to reviewer group got reassigned"},"components/examples/reassign-reviews-response-response-03-multi-level-campaign-at-level1-initially-assigned-to-reviewer-group":{"id":"components/examples/reassign-reviews-response-response-03-multi-level-campaign-at-level1-initially-assigned-to-reviewer-group","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","currentReviewerLevel":"FIRST","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u2iudyie873","email":"juan.garcia@example.com","firstName":"Juan","lastName":"Garcia","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","currentReviewerLevel":"FIRST","id":"icrhew4DFTxygUUgE0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhew4DFTxygUUgE0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00847dfjhgd98","email":"tal.gupta@example.com","firstName":"Tal","lastName":"Gupta","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","currentReviewerLevel":"FIRST","id":"icrhfvRCfGCHk3y2h0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhfvRCfGCHk3y2h0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/61eb2db568c7c300079fefd0/reviews/reassign"}}},"summary":"List of reviews that were originally assigned to reviewer group at level 1"},"components/examples/reassign-reviews-response-response-04-entitlement-bundle-details":{"id":"components/examples/reassign-reviews-response-response-04-entitlement-bundle-details","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u2iudyie873","email":"tal.gupta@example.com","firstName":"Tal","lastName":"Gupta","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhew4DFTxygUUgE0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhew4DFTxygUUgE0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00847dfjhgd98","email":"juan.garcia@example.com","firstName":"Juan","lastName":"Garcia","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhfvRCfGCHk3y2h0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhfvRCfGCHk3y2h0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/61eb2db568c7c300079fefd0/reviews/reassign"}}},"summary":"Multi level campaign - success response to get a review details with details at all reviewer levels","description":"For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."},"components/examples/reassign-reviews-response-response-04-entitlement-value-details":{"id":"components/examples/reassign-reviews-response-response-04-entitlement-value-details","value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%icitdyhndQ6qstyvR8g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"summary":"Multi level campaign - success response to get a review details with details at all reviewer levels","description":"For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."},"components/examples/review-get-response-01-basic-details":{"id":"components/examples/review-get-response-01-basic-details","value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"SUCCESS","note":{"id":"389dhie83","note":"reason for approval"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"USER","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"summary":"Success response to get a review details","description":"Success response to get a review details."},"components/examples/review-get-response-02-with-reviewer-group":{"id":"components/examples/review-get-response-02-with-reviewer-group","value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"SUCCESS","note":{"id":"389dhie83","note":"reason for approval"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"GROUP","reviewerGroupProfile":{"name":"Dev-Ops Admins","groupId":"00g12gxEULnaMZobr0g4","groupType":"GROUP"},"created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"summary":"Success response to get a review details with reviewer group profile","description":"Success response to get a review details with reviewer group profile"},"components/examples/review-get-response-03-multi-level-level1-reviewer-group-and-level2-user":{"id":"components/examples/review-get-response-03-multi-level-level1-reviewer-group-and-level2-user","value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"REVOKE","remediationStatus":"SUCCESS","currentReviewerLevel":"SECOND","note":{"id":"389dhie83","note":"reason for revocation"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"USER","allReviewerLevels":[{"id":"rir77bgs1VB5d45Ot0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"FIRST","decision":"APPROVE","reviewerProfile":{"id":"00u11gerKM8KRGutA0g5","email":"reviewer1@reviewer.com","firstName":"reviewer1","lastName":"reviewer1","status":"ACTIVE"},"reviewerType":"GROUP","reviewerGroupProfile":{"groupId":"00g141t8uX0rYaIpS0g4","name":"Dev-Ops Admins","globalName":"Dev-Ops Admins","groupType":"GROUP"}},{"id":"rir77bhvegddkTFIc0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"SECOND","decision":"REVOKE","reviewerProfile":{"id":"00u11get1k7R75JrS0g5","email":"reviewer2@reviewer.com","firstName":"reviewer2","lastName":"reviewer2","status":"ACTIVE"},"reviewerType":"USER"}],"created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"summary":"Multi level campaign - success response to get a review details with details at all reviewer levels","description":"For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."},"components/examples/review-get-response-04-entitlement-bundle-details":{"id":"components/examples/review-get-response-04-entitlement-bundle-details","value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"entitlementBundle":{"id":"ebnb0oNGTSWTBKOLGLNR","name":"Entitlement bundle Name"},"decision":"REVOKE","remediationStatus":"SUCCESS","currentReviewerLevel":"SECOND","note":{"id":"389dhie83","note":"reason for revocation"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"USER","allReviewerLevels":[{"id":"rir77bgs1VB5d45Ot0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"FIRST","decision":"APPROVE","reviewerProfile":{"id":"00u11gerKM8KRGutA0g5","email":"reviewer1@reviewer.com","firstName":"reviewer1","lastName":"reviewer1","status":"ACTIVE"},"reviewerType":"GROUP","reviewerGroupProfile":{"groupId":"00g141t8uX0rYaIpS0g4","globalName":"Dev-Ops Amins","name":"Dev-Ops Admins","groupType":"GROUP"}},{"id":"rir77bhvegddkTFIc0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"SECOND","decision":"REVOKE","reviewerProfile":{"id":"00u11get1k7R75JrS0g5","email":"reviewer2@reviewer.com","firstName":"reviewer2","lastName":"reviewer2","status":"ACTIVE"},"reviewerType":"USER"}],"created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"summary":"Multi level campaign - success response to get a review details with details at all reviewer levels","description":"For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."},"components/examples/review-get-response-05-entitlement-value-details":{"id":"components/examples/review-get-response-05-entitlement-value-details","value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"entitlementValue":{"id":"entb0oNGTSWTBKOLGLNR","name":"Admin access","externalValue":"admin","entitlement":{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role"}},"decision":"REVOKE","remediationStatus":"SUCCESS","currentReviewerLevel":"SECOND","note":{"id":"389dhie83","note":"reason for revocation"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"USER","allReviewerLevels":[{"id":"rir77bgs1VB5d45Ot0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"FIRST","decision":"APPROVE","reviewerProfile":{"id":"00u11gerKM8KRGutA0g5","email":"reviewer1@reviewer.com","firstName":"reviewer1","lastName":"reviewer1","status":"ACTIVE"},"reviewerType":"GROUP","reviewerGroupResourceId":"00g141t8uX0rYaIpS0g4","reviewerGroupProfile":{"groupId":"00g141t8uX0rYaIpS0g4","globalName":"Dev-Ops Amins","name":"Dev-Ops Admins","groupType":"GROUP"}},{"id":"rir77bhvegddkTFIc0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"SECOND","decision":"REVOKE","reviewerProfile":{"id":"00u11get1k7R75JrS0g5","email":"reviewer2@reviewer.com","firstName":"reviewer2","lastName":"reviewer2","status":"ACTIVE"},"reviewerType":"USER"}],"created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"summary":"Multi level campaign - success response to get a review details with details at all reviewer levels","description":"For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."},"components/examples/entitlement-bundles-list-no-filter":{"id":"components/examples/entitlement-bundles-list-no-filter","value":{"data":[{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles?limit=20"}},"metadata":{"total":10}},"summary":"List entitlement bundles response with no filter","description":"A list of entitlement bundle with no filter"},"components/examples/entitlement-bundles-list-with-entitlements-no-filter":{"id":"components/examples/entitlement-bundles-list-with-entitlements-no-filter","value":{"data":[{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"Role","externalValue":"Role","description":"Role entitlement property","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Admin access","externalValue":"admin","description":"provides admin access role"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles?limit=20"}},"metadata":{"total":10}},"summary":"List entitlement bundles response with full entitlements","description":"A list of entitlement bundles with full entitlements"},"components/examples/entitlement-bundles-list-bad-request-empty-after":{"id":"components/examples/entitlement-bundles-list-bad-request-empty-after","value":{"errorCode":"E0000029","errorSummary":"Invalid paging request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Empty value found for query parameter 'after'","reason":"empty.openapi.validation","locationType":"query","location":"/query/after"}]},"summary":"When after parameter is empty"},"components/examples/entitlement-bundles-list-bad-request-invalid-after":{"id":"components/examples/entitlement-bundles-list-bad-request-invalid-after","value":{"errorCode":"E0000029","errorSummary":"Invalid paging request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"must NOT have fewer than 24 characters","reason":"minLength.openapi.validation","locationType":"query","location":"/query/after"},{"errorSummary":"must match pattern \"^[a-fA-F\\\\d]{24}$\"","reason":"pattern.openapi.validation","locationType":"query","location":"/query/after"},{"errorSummary":"must match format \"entitlement-bundle-id\"","reason":"format.openapi.validation","locationType":"query","location":"/query/after"},{"errorSummary":"format is invalid","reason":"serdes.openapi.validation","locationType":"query","location":"/query/after"}]},"summary":"When after parameter is invalid format"},"components/examples/entitlement-bundles-list-bad-request-not-exist-after":{"id":"components/examples/entitlement-bundles-list-bad-request-not-exist-after","value":{"errorCode":"E0000029","errorSummary":"Invalid paging request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Request type 08ab2db568c7c300079fefd0 not found","reason":"serdes.openapi.validation","locationType":"query","location":"/query/after"}]},"summary":"When after parameter value not found","description":"When a request contains after query parameter with request id that does not exist"},"components/examples/entitlement-bundle-creatable-00-single-value-example":{"id":"components/examples/entitlement-bundle-creatable-00-single-value-example","value":{"name":"Salesforce admin bundle","description":"A bundle for full administrative access in salesforce","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}]},"summary":"One entitlement, one value","description":"Request body for adding an entitlement bundle with one entitlement, one value"},"components/examples/entitlement-bundle-creatable-01-multi-value-example":{"id":"components/examples/entitlement-bundle-creatable-01-multi-value-example","value":{"name":"Salesforce admin bundle","description":"A bundle for full administrative access in salesforce","target":{"type":"APPLICATION","externalId":"0oafxqCAJWWGELFTYASJ"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]}]},"summary":"One entitlement, two entitlement values","description":"Request body for adding an entitlement bundle with many entitlements"},"components/examples/entitlement-bundle-creatable-00-single-value-full-example":{"id":"components/examples/entitlement-bundle-creatable-00-single-value-full-example","value":{"id":"enbo3j1lwErh6dn701d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYAAA"}}},"summary":"Entitlement Bundle with single entitlement","description":"Entitlement Bundle with one entitlement and one value"},"components/examples/entitlement-bundle-creatable-01-multi-value-full-example":{"id":"components/examples/entitlement-bundle-creatable-01-multi-value-full-example","value":{"id":"enbo3j1lwErh6dn701d6","name":"Salesforce admin bundle","description":"Salesforce profile","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}},"summary":"Entitlement Bundle with multiple entitlement values","description":"Entitlement bundle with many entitlements"},"components/examples/entitlement-bundle-settings-missing":{"id":"components/examples/entitlement-bundle-settings-missing","value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The settings for a entitlement bundle must be specified.","reason":"MISSING_SETTINGS","locationType":"body","location":"settings","domain":"entitlement-bundle"}]},"description":"When no resources are provided"},"components/examples/entitlement-bundle-single-value-full-example":{"id":"components/examples/entitlement-bundle-single-value-full-example","value":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"Role","externalValue":"Role","description":"Role entitlement property","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Admin access","externalValue":"admin","description":"provides admin access role"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYAAA"}}},"summary":"Entitlement Bundle with full entitlement and one entitlement value","description":"Entitlement Bundle with full entitlement and one entitlement value"},"components/examples/entitlement-bundle-multi-value-full-example":{"id":"components/examples/entitlement-bundle-multi-value-full-example","value":{"id":"enbo3j1lwErh6dn701d6","name":"Salesforce admin bundle","description":"Salesforce profile","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"License entitlement property","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","externalValue":"A","name":"A Label","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}},"summary":"Entitlement Bundle with full entitlement and many entitlements values","description":"Entitlement bundle with full entitlement and many entitlements values"},"components/examples/entitlement-bundle-updatable-00-single-value-example":{"id":"components/examples/entitlement-bundle-updatable-00-single-value-example","value":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3ioilCWXR316t1d6"}]}]},"summary":"Update entitlements for a bundle","description":"Entitlement bundle with multiple entitlements values"},"components/examples/entitlement-bundle-updatable-01-name-description-example":{"id":"components/examples/entitlement-bundle-updatable-01-name-description-example","value":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle (updated)","description":"Github bundle for administrative access (updated)","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3ioilCWXR316t1d6"}]}]},"summary":"Update name and description for a bundle","description":"Entitlement bundle with multiple entitlement values"},"components/examples/entitlement-bundle-entitlements-missing":{"id":"components/examples/entitlement-bundle-entitlements-missing","value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The entitlements for a entitlement bundle must be specified.","reason":"MISSING_ENTITLEMENTS","locationType":"body","location":"entitlements","domain":"entitlement-bundle"}]},"description":"When no entitlements are provided"},"components/examples/entitlement-bundle-name-missing":{"id":"components/examples/entitlement-bundle-name-missing","value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The name for a entitlement bundle must be specified.","reason":"MISSING_NAME","locationType":"body","location":"name","domain":"entitlement-bundle"}]},"description":"When no name is provided"},"components/examples/entitlement-bundle-delete-deleted-example":{"id":"components/examples/entitlement-bundle-delete-deleted-example","value":{"errorCode":"E0000169","errorSummary":"Object status conflicts with requested operation.","errorLink":"E0000169","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"A Request type with status DELETED may not be deleted.","reason":"OPERATION_STATUS_CONFLICT","locationType":"method","location":"POST","domain":"entitlement-bundle"}]},"summary":"Conflict deleting a deleted Request type","description":"When attempting to delete a deleted Request type"},"components/examples/resource-assets-list":{"id":"components/examples/resource-assets-list","value":{"data":[{"id":"reafxqCAJWWGELFTYASJ","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:resource-assets:reafxqCAJWWGELFTYASJ","name":"Project 3","description":"Example description for a resource asset","type":{"id":"retabcdefgHIJKLMNOPQ","displayName":"Project"},"externalId":"123456789012","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","hasChildren":false,"parentId":"reafxqCAJWWGEGPNXZSF","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGELFTYASJ"},"parent":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGEGPNXZSF"},"children":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets?filter=parentId%20eq%20%22reafxqCAJWWGELFTYASJ%22"}}},{"id":"reafxqCAJWWGEGUUFASJ","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:resource-assets:reafxqCAJWWGEGUUFASJ","name":"Project 4","description":"Example description for a resource asset","type":{"id":"retabcdefgHIJKLMNOPQ","displayName":"Project"},"externalId":"123456789013","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","hasChildren":true,"parentId":"reafxqCAJWWGEGPNXZSF","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGEGUUFASJ"},"parent":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGEGPNXZSF"},"children":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets?filter=parentId%20eq%20%22reafxqCAJWWGEGUUFASJ%22"}}},{"id":"reafxqCAJWWGEHZZBBQQ","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:resource-assets:reafxqCAJWWGEHZZBBQQ","name":"Other Project","description":"Example description for a resource asset","type":{"id":"retabcdefgHIJKLMNOPQ","displayName":"Project"},"externalId":"123456789014","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","hasChildren":false,"parentId":"reafxqCAJWWGEGPHXQNN","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGEHZZBBQQ"},"parent":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGEGPHXQNN"},"children":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets?filter=parentId%20eq%20%22reafxqCAJWWGEHZZBBQQ%22"}}}],"ancestors":{"reafxqCAJWWGEGPNXZSF":{"id":"reafxqCAJWWGEGPNXZSF","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:resource-assets:reafxqCAJWWGEGPNXZSF","name":"Project 2","type":{"id":"retabcdefgHIJKLMNOPQ","displayName":"Project"},"parentId":"reafxqCAJWWGEGPHXQNN","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGEGPNXZSF"}}},"reafxqCAJWWGEGPHXQNN":{"id":"reafxqCAJWWGEGPHXQNN","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:resource-assets:reafxqCAJWWGEGPHXQNN","name":"Project 1","type":{"id":"retabcdefgHIJKLMNOPQ","displayName":"Project"},"parentId":null,"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGEGPHXQNN"}}}},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets"}}},"summary":"List resource assets for a specific resource","description":"A list of resource assets"},"components/examples/resource-asset-get-success-example":{"id":"components/examples/resource-asset-get-success-example","value":{"id":"reafxqCAJWWGELFTYASJ","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:resource-assets:reafxqCAJWWGELFTYASJ","name":"Project 123","description":"Example description for a resource asset","type":{"id":"retabcdefgHIJKLMNOPQ","displayName":"Project"},"externalId":"123456789012","created":"2025-08-08T14:15:22Z","createdBy":"00u2lxfQaw8WRlkQt0g4","lastUpdated":"2025-08-28T14:15:22Z","lastUpdatedBy":"00u2lxfQaw8WRlkQt0g4","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource/orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:my-app:0oafxqCAJWWGELFTYASJ/assets/reafxqCAJWWGELFTYASJ"}}},"summary":"Retrieve or update a resource asset response","description":"Retrieve or update a resource asset response"},"components/examples/resource-asset-update-example":{"id":"components/examples/resource-asset-update-example","value":{"description":"Example description for a resource asset"},"summary":"Update resource asset","description":"Request body for updating a resource asset"},"components/examples/resource-asset-types-list-example":{"id":"components/examples/resource-asset-types-list-example","value":{"data":[{"id":"retabcdefgHIJKLMNOPQ","displayName":"Account","created":"2024-01-15T10:30:00Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-01-15T10:30:00Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://{myOktaDomain}/governance/api/v1/resource-asset-types/retabcdefgHIJKLMNOPQ"}}}],"_links":{"self":{"href":"https://{myOktaDomain}/governance/api/v1/resource-asset-types"}}},"summary":"List resource asset types for a specific resource","description":"A list of resource asset types"},"components/examples/resource-asset-type-get-success-example":{"id":"components/examples/resource-asset-type-get-success-example","value":{"id":"retabcdefgHIJKLMNOPQ","displayName":"Account","created":"2024-01-15T10:30:00Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-01-15T10:30:00Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://{myOktaDomain}/governance/api/v1/resource-asset-types/retabcdefgHIJKLMNOPQ"}}},"summary":"Retrieve a resource asset type response","description":"Retrieve a resource asset type response"},"components/examples/grants-success-response":{"id":"components/examples/grants-success-response","value":{"data":[{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"ACCESS_REQUEST","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"},"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbfxqCAJWWGELFTYCCC"}}},{"id":"0ggb0oNGTSWTBKOJGDS","created":"2022-03-23T11:11:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-03-23T11:11:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"POLICY","action":"ALLOW","actor":"NONE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOJGDS"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants?filter=\"target.externalId%20eq%20%220oafxqCAJWWGELFTYASJ%22%20AND%20target.type%20eq%20%22APPLICATION%22%20AND%20targetPrincipal.externalId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20AND%20targetPrincipal.type%20eq%20%22OKTA_USER%22\""}}},"summary":"Grants list with multiple active grants"},"components/examples/grants-success-custom-response":{"id":"components/examples/grants-success-custom-response","value":{"data":[{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"},{"id":"ent4rg7fu190Eg75a8g6","name":"D label","externalValue":"D","description":"D label description"}]}],"targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants?filter=\"target.externalId%20eq%20%220oafxqCAJWWGELFTYASJ%22%20AND%20target.type%20eq%20%22APPLICATION%22%20AND%20targetPrincipal.externalId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20AND%20targetPrincipal.type%20eq%20%22OKTA_USER%22\""}}},"summary":"Grants list with only custom grant type","description":"Grants list for a resource and user with only Custom grant type with full entitlements"},"components/examples/grants-success-with-metadata-response":{"id":"components/examples/grants-success-with-metadata-response","value":{"data":[{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","metadata":{"id":"00cfxqCAJWWGELFTYAAA","name":"Some collection name"},"values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"},{"id":"ent4rg7fu190Eg75a8g6","name":"D label","externalValue":"D","description":"D label description"}]}],"targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants?filter=\"target.externalId%20eq%20%220oafxqCAJWWGELFTYASJ%22%20AND%20target.type%20eq%20%22APPLICATION%22%20AND%20targetPrincipal.externalId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20AND%20targetPrincipal.type%20eq%20%22OKTA_USER%22\""}}},"summary":"Grants list with metadata included","description":"Grants list for a resource and user with metadata included"},"components/examples/grants-list-empty-target-resource":{"id":"components/examples/grants-list-empty-target-resource","value":{"errorCode":"E0000029","errorSummary":"Invalid filter","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Cannot find value found for target resource'","reason":"empty.openapi.validation","locationType":"query","location":"/query/filter"}]},"summary":"When no target resource provided in filter","description":"When a request contains filter without a target resource"},"components/examples/grants-list-multiple-target-resource":{"id":"components/examples/grants-list-multiple-target-resource","value":{"errorCode":"E0000029","errorSummary":"Invalid filter","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Multiple values found for target resource'","reason":"empty.openapi.validation","locationType":"query","location":"/query/filter"}]},"summary":"When multiple target resource provided in filter","description":"When a request contains filter with multiple target resource"},"components/examples/grants-list-invlaid-entitlements":{"id":"components/examples/grants-list-invlaid-entitlements","value":{"errorCode":"E0000007","errorSummary":"Resource not found exception.","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Cannot find entitlement with id 08ab2db568c7c300079fefd0","reason":"empty.openapi.validation","locationType":"query","location":"/query/filter"}]},"summary":"When invalid entitlement id or entitlement value id is provided","description":"When a request contains filter with invalid entitlement id or entitlement value id"},"components/examples/grant-bundle-creatable-00-no-expiration-example":{"id":"components/examples/grant-bundle-creatable-00-no-expiration-example","value":{"grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","actor":"ACCESS_REQUEST","targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"}},"summary":"Grant a bundle to a principal"},"components/examples/grant-bundle-creatable-01-expiration-example":{"id":"components/examples/grant-bundle-creatable-01-expiration-example","value":{"grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","actor":"ACCESS_REQUEST","targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"},"scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z"}},"summary":"Grant a bundle to a principal, with an expiration date"},"components/examples/grant-policy-creatable-00-example":{"id":"components/examples/grant-policy-creatable-00-example","value":{"grantType":"POLICY","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"}},"summary":"Grant using a policy","description":"Grant using a policy"},"components/examples/grant-custom-creatable-01-multiple-value-example":{"id":"components/examples/grant-custom-creatable-01-multiple-value-example","value":{"grantType":"CUSTOM","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}]},"summary":"Custom grant with entitlements","description":"Custom grant using entitlements with single and multi value properties"},"components/examples/grant-custom-deny-01-example":{"id":"components/examples/grant-custom-deny-01-example","value":{"grantType":"CUSTOM","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"},"action":"DENY"},"summary":"Revoke all grants for a principal","description":"Revoke all grants for a principal. This will also take away access to the resource."},"components/examples/grant-entitlement-creatable-example":{"id":"components/examples/grant-entitlement-creatable-example","value":{"grantType":"ENTITLEMENT","target":{"externalId":"0oa251e7jQHXVgg5r0g4","type":"APPLICATION"},"targetPrincipal":{"externalId":"00um8cshZwJhHgpvV0g4","type":"OKTA_USER"},"entitlements":[{"id":"esp1o5jmfBTZUCzcW0g5","values":[{"id":"ent1o5jo0bHpxiDVJ0g5"}]}]},"summary":"Entitlement grant with values","description":"Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements."},"components/examples/grant-bundle-creatable-00-no-expiration-full-example":{"id":"components/examples/grant-bundle-creatable-00-no-expiration-full-example","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"ACCESS_REQUEST","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbfxqCAJWWGELFTYCCC"},"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Grant a bundle to a principal"},"components/examples/grant-bundle-creatable-01-expiration-full-example":{"id":"components/examples/grant-bundle-creatable-01-expiration-full-example","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z","timeZone":"America/Toronto"},"_links":{"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYCCC"},"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Grant a bundle to a principal, with expiration"},"components/examples/grant-policy-full-example":{"id":"components/examples/grant-policy-full-example","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"POLICY","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","action":"ALLOW","actor":"NONE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Grant a resource with policy","description":"Grant a resource with policy"},"components/examples/grant-custom-full-example":{"id":"components/examples/grant-custom-full-example","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ent6asdxmkvabcltm3g5"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Custom Grant with entitlements","description":"Grant a resource with custom entitlements"},"components/examples/grant-entitlement-creatable-full-example":{"id":"components/examples/grant-entitlement-creatable-full-example","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4","target":{"externalId":"0oa251e7jQHXVgg5r0g4","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4","targetPrincipal":{"externalId":"00um8cshZwJhHgpvV0g4","type":"OKTA_USER"},"entitlements":[{"id":"esp1o5jmfBTZUCzcW0g5","values":[{"id":"ent1o5jo0bHpxiDVJ0g5"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Entitlement grant with values"},"components/examples/entitlement-bundle-missing":{"id":"components/examples/entitlement-bundle-missing","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /entitlementBundleId 61eb2db568c7c300079fefd0 not found","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"governance","errorSummary":"61eb2db568c7c300079fefd0 not found","location":"/entitlementBundleId","locationType":"body","reason":"IDENTIFIER_NOT_FOUND"}]},"summary":"When the entitlement bundle cannot be found","description":"Bad request response when entitlementBundleId cannot be found."},"components/examples/grant-custom-with-full-entitlements":{"id":"components/examples/grant-custom-with-full-entitlements","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fu190Eg75a8g6","name":"C label","externalValue":"C","description":"C label description"},{"id":"ent4rg7fltWSgrlDT8g6","name":"D label","externalValue":"D","description":"D label description"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Custom Grant a resource with full entitlements loaded","description":"Grant a resource with custom entitlements"},"components/examples/grant-custom-with-metadata":{"id":"components/examples/grant-custom-with-metadata","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}],"status":"ACTIVE","metadata":{"collection":{"id":"00cb0oNGTSWTBKOLGLNR","name":"Some Collection"}},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Custom Grant with metadata","description":"Grant for a resource with custom entitlements and grant metadata"},"components/examples/grant-custom-update-entitlements":{"id":"components/examples/grant-custom-update-entitlements","value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"summary":"Update custom grant entitlements","description":"Update custom grant entitlements."},"components/examples/grant-bundle-patch-expiration-date":{"id":"components/examples/grant-bundle-patch-expiration-date","value":{"id":"0ggb0oNGTSWTBKOLGLNR","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z"}},"summary":"Update grant's expiration date","description":"Update grant's expiration date."},"components/examples/grant-bundle-patch-expiration-date-timezone":{"id":"components/examples/grant-bundle-patch-expiration-date-timezone","value":{"id":"0ggb0oNGTSWTBKOLGLNR","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z","timeZone":"America/Toronto"}},"summary":"Update grant's expiration date and user timezone","description":"Update the grant expiry date (in UTC time) and save the user time zone"},"components/examples/grant-id-missing":{"id":"components/examples/grant-id-missing","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /grantId 61eb2db568c7c300079fefd0 not found","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"governance","errorSummary":"61eb2db568c7c300079fefd0 not found","location":"/grantId","locationType":"body","reason":"IDENTIFIER_NOT_FOUND"}]},"summary":"When the grant id cannot be found","description":"Bad request response when grantId cannot be found."},"components/examples/entitlements-list-filter":{"id":"components/examples/entitlements-list-filter","value":{"data":[{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":true,"required":false,"dataType":"string","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values"}}},{"id":"espfxqCAJWWGEGUUFASJ","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGEGUUFASJ"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGEGUUFASJ/values"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements?limit=20"}},"metadata":{"total":2}},"summary":"List entitlements for a specific resource","description":"A list of entitlements"},"components/examples/invalid-external-id":{"id":"components/examples/invalid-external-id","value":{"errorCode":"E0000029","errorSummary":"Invalid externalId request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"0oab2db568c7c300079fefd0 not found","reason":"IDENTIFIER_NOT_FOUND","locationType":"query","location":"/target.externalId","domain":"governance"}]},"summary":"When target.externalId not found","description":"When a request contains target.externalId query parameter with id that does not exist"},"components/examples/entitlement-create-example":{"id":"components/examples/entitlement-create-example","value":{"name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"dataType":"string","values":[{"name":"value1","description":"description for value1","externalValue":"value_1"},{"name":"value2","description":"description for value2","externalValue":"value_2"}]},"summary":"New entitlement","description":"Request body for adding an entitlement"},"components/examples/entitlement-create-success-example":{"id":"components/examples/entitlement-create-success-example","value":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"required":false,"dataType":"string","values":[{"id":"ent148fuJDGTsvYjP0g4","name":"value1","description":"description for value1","externalValue":"value_1","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148fuJDGT"},{"id":"ent148gF8aZoRfFsh0g4","name":"value2","description":"description for value2","externalValue":"value_2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148gF8aZoRfFsh0g4"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6/values"}},"metadata":{"total":2}},"summary":"Create entitlement example","description":"Response for a successful entitlement creation"},"components/examples/request-field-missing-example":{"id":"components/examples/request-field-missing-example","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /requiredField/0 must cannot be null","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"entitlements","errorSummary":"must have required field","location":"/requiredField/","locationType":"body","reason":"REQUIRED_PROPERTY_MISSING"}]},"summary":"When required field is missing","description":"When the requiredField is missing"},"components/examples/entitlement-get-success-example":{"id":"components/examples/entitlement-get-success-example","value":{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":true,"required":false,"dataType":"string","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values"}},"metadata":{"total":1}},"summary":"Retrieve an entitlement response","description":"Retrieve an entitlement response"},"components/examples/entitlement-update-example":{"id":"components/examples/entitlement-update-example","value":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement","externalValue":"license_entitlement","description":"Entitlement description","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"dataType":"string","values":[{"id":"ent148gF8aZoRfFsh0g4","name":"value1","description":"description for value1","externalValue":"value_1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148gF8aZoRfFsh0g4"},{"id":"entotuwr1z1efm5RA1d6","name":"value2","description":"new value for entitlement","externalValue":"value_2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entotuwr1z1efm5RA1d6"}]},"summary":"Update an entitlement","description":"Request body for updating an entitlement"},"components/examples/entitlement-update-success-example":{"id":"components/examples/entitlement-update-success-example","value":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"dataType":"string","required":false,"values":[{"id":"ent148gF8aZoRfFsh0g4","name":"Updated value1","description":"description for value1","externalValue":"value_1","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148gF8aZoRfFsh0g4"},{"id":"ent148fuJDGTsvYjP0g4","name":"Updated value2","description":"description for value2","externalValue":"value_2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148fuJDGTsvYjP0g4"}],"_links":{"self":{"href":"https://myorg.okta.com//governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6"},"values":{"href":"https://myorg.okta.com//governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6/values"}},"metadata":{"total":2}},"summary":"Update entitlement example","description":"Response for successful entitlement update"},"components/examples/entitlement-value-update-example":{"id":"components/examples/entitlement-value-update-example","value":[{"op":"ADD","path":"/values/-","value":{"name":"value1","description":"description for value1","externalValue":"value_1"},"refType":"ENTITLEMENT-VALUE"},{"op":"REMOVE","path":"/values/ent148gF8aZoRfFsh0g4","refType":"ENTITLEMENT-VALUE"},{"op":"REPLACE","path":"/values/ent148gF8aZoRfFsh0g4","value":{"name":"value1","description":"replace description for value1"},"refType":"ENTITLEMENT-VALUE"},{"op":"ADD","path":"/description","value":"add description for entitlement","refType":"ENTITLEMENT"},{"op":"REMOVE","path":"/description","refType":"ENTITLEMENT"},{"op":"REPLACE","path":"/description","value":"replace description for entitlement","refType":"ENTITLEMENT"},{"op":"REPLACE","path":"/name","value":"replace name for entitlement","refType":"ENTITLEMENT"}],"summary":"Update entitlement","description":"Request body for updating entitlement"},"components/examples/entitlement-value-update-add-example":{"id":"components/examples/entitlement-value-update-add-example","value":[{"op":"ADD","path":"/values/-","value":{"name":"value1","description":"description for value1","externalValue":"value_1"},"refType":"ENTITLEMENT-VALUE"}],"summary":"Update - add entitlement value","description":"Request body for adding entitlement value"},"components/examples/entitlement-value-update-remove-example":{"id":"components/examples/entitlement-value-update-remove-example","value":[{"op":"REMOVE","path":"/values/ent148gF8aZoRfFsh0g4","refType":"ENTITLEMENT-VALUE"}],"summary":"Update - remove entitlement value","description":"Request body for removing entitlement value"},"components/examples/entitlement-value-update-replace-example":{"id":"components/examples/entitlement-value-update-replace-example","value":[{"op":"REPLACE","path":"/values/ent148gF8aZoRfFsh0g4","value":{"name":"value1","description":"replace description for value1"},"refType":"ENTITLEMENT-VALUE"}],"summary":"Update - replace entitlement value","description":"Request body for replacing entitlement value"},"components/examples/values-list-success-example":{"id":"components/examples/values-list-success-example","value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","externalValue":"corporate","entitlementId":"esp81PLbVQGWaklZb0g2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"summary":"List of values for a specific resource","description":"A list of entitlement values"},"components/examples/values-list-success-with-external-id-example":{"id":"components/examples/values-list-success-with-external-id-example","value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","entitlementId":"esp5zFLCIUV7Vibro0g2","externalValue":"{\"name\":\"admin\", \"externalId\":\"75941239-123s-1245-xyz6-562fee27167r\"}","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","entitlementId":"esp81PLbVQGWaklZb0g2","externalValue":"{\"name\":\"corporate\", \"externalId\":\"75941239-123s-1245-xyz6-562fee27167r\"}","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"summary":"List of values for a specific resource with an external value ID","description":"A list of entitlement values with an external value ID"},"components/examples/values-list-with-labels-success-example":{"id":"components/examples/values-list-with-labels-success-example","value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}}]},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","externalValue":"corporate","entitlementId":"esp81PLbVQGWaklZb0g2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"summary":"List of values for a specific resource including assigned labels","description":"A list of entitlement values with assigned labels"},"components/examples/entitlement-value-get-success-example":{"id":"components/examples/entitlement-value-get-success-example","value":{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},"summary":"Entitlement value data","description":"Entitlement value data"},"components/examples/entitlement-drifts-list-example":{"id":"components/examples/entitlement-drifts-list-example","value":{"data":[{"id":"edrx9p2mTRIFTAAAAAAA","created":"2026-05-22T16:21:14Z","createdBy":"system","lastUpdated":"2026-05-22T16:21:14Z","lastUpdatedBy":"system","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:saml:0oafxqCAJWWGELFTYASJ","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00uxqCAJWWGELFTYASJK","importJobId":"imp_2026_05_22_a1b2c3","driftType":"ADD","status":"APPLIED","resolution":"AUTO_ACCEPTED","entitlement":{"schemaPropertyId":"esp_crm_permission_set","id":"ent_ps_4","value":"PS-4","externalId":"0PS00000ABC"},"resolvedGrantId":"agz0impTRSAAAAAAA0g5","_links":{"self":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/drifts/edrx9p2mTRIFTAAAAAAA"},"revert":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/drifts/edrx9p2mTRIFTAAAAAAA/revert"}}},{"id":"edrx9p2mTRSUBAAAAAAA","created":"2026-05-22T16:22:01Z","createdBy":"system","lastUpdated":"2026-05-22T16:22:02Z","lastUpdatedBy":"system","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:saml:0oafxqCAJWWGELFTYASJ","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00uxqCAJWWGELFTYASJK","importJobId":"imp_2026_05_22_a1b2c3","driftType":"SUB","status":"APPLIED","resolution":"CONFLICT_REJECTED","entitlement":{"schemaPropertyId":"esp_crm_permission_set","id":"ent_ps_1","value":"PS-1","externalId":"0PS00000XYZ"},"affectedGrantSource":"POLICY","affectedGrantId":"agz0polRSAAAAAAAA0g5","_links":{"self":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/drifts/edrx9p2mTRSUBAAAAAAA"}}}],"_links":{"self":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/drifts?resourceId=0oafxqCAJWWGELFTYASJ&limit=20"}},"metadata":{"total":2}},"summary":"A page of drifts"},"components/examples/entitlement-drifts-list-missing-anchor-example":{"id":"components/examples/entitlement-drifts-list-missing-anchor-example","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: filter","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-MISS","errorCauses":[{"errorSummary":"Filter must include resourceId or principalId with the eq operator","reason":"MISSING_ANCHOR_FILTER","locationType":"query","location":"/query/filter"}]},"summary":"The filter doesn't scope to a resource or principal"},"components/examples/entitlement-drifts-list-multiple-anchors-example":{"id":"components/examples/entitlement-drifts-list-multiple-anchors-example","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: filter","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-MULT","errorCauses":[{"errorSummary":"Filter must include exactly one of resourceId or principalId, not both","reason":"MULTIPLE_ANCHOR_FILTERS","locationType":"query","location":"/query/filter"}]},"summary":"The filter scopes to both a resource and a principal"},"components/examples/entitlement-drift-add-applied-example":{"id":"components/examples/entitlement-drift-add-applied-example","value":{"id":"edrx9p2mTRIFTAAAAAAA","created":"2026-05-22T16:21:14Z","createdBy":"system","lastUpdated":"2026-05-22T16:21:14Z","lastUpdatedBy":"system","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:saml:0oafxqCAJWWGELFTYASJ","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00uxqCAJWWGELFTYASJK","importJobId":"imp_2026_05_22_a1b2c3","driftType":"ADD","status":"APPLIED","resolution":"AUTO_ACCEPTED","entitlement":{"schemaPropertyId":"esp_crm_permission_set","id":"ent_ps_4","value":"PS-4","externalId":"0PS00000ABC"},"resolvedGrantId":"agz0impTRSAAAAAAA0g5","_links":{"self":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/drifts/edrx9p2mTRIFTAAAAAAA"},"revert":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/drifts/edrx9p2mTRIFTAAAAAAA/revert"},"resource":{"href":"https://example.okta.com/api/v1/apps/0oafxqCAJWWGELFTYASJ"},"principal":{"href":"https://example.okta.com/api/v1/users/00uxqCAJWWGELFTYASJK"}}},"summary":"An accepted addition"},"components/examples/entitlement-drift-sub-conflict-example":{"id":"components/examples/entitlement-drift-sub-conflict-example","value":{"id":"edrx9p2mTRSUBAAAAAAA","created":"2026-05-22T16:22:01Z","createdBy":"system","lastUpdated":"2026-05-22T16:22:02Z","lastUpdatedBy":"system","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:saml:0oafxqCAJWWGELFTYASJ","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00uxqCAJWWGELFTYASJK","importJobId":"imp_2026_05_22_a1b2c3","driftType":"SUB","status":"APPLIED","resolution":"CONFLICT_REJECTED","entitlement":{"schemaPropertyId":"esp_crm_permission_set","id":"ent_ps_1","value":"PS-1","externalId":"0PS00000XYZ"},"affectedGrantSource":"POLICY","affectedGrantId":"agz0polRSAAAAAAAA0g5","_links":{"self":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/drifts/edrx9p2mTRSUBAAAAAAA"},"resource":{"href":"https://example.okta.com/api/v1/apps/0oafxqCAJWWGELFTYASJ"},"principal":{"href":"https://example.okta.com/api/v1/users/00uxqCAJWWGELFTYASJK"}}},"summary":"A conflict-rejected removal","description":"An entitlement granted by an access policy was missing from the import. Okta never removes a birthright entitlement, so it pushed the original assignment back to the app."},"components/examples/entitlement-drift-revert-not-revertible-example":{"id":"components/examples/entitlement-drift-revert-not-revertible-example","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: driftId","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-DNR1","errorCauses":[{"errorSummary":"The entitlement drift edrx9p2mTRIFTAAAAAAA cannot be reverted in its current state. Reverting requires an applied, auto-accepted drift; an already-reverted drift is the most common cause.","reason":"DRIFT_NOT_REVERTIBLE","locationType":"url","location":"driftId"}]},"summary":"The drift isn't in a revertible state"},"components/examples/entitlement-reconciliation-config-full-example":{"id":"components/examples/entitlement-reconciliation-config-full-example","value":{"id":"rcc0cfgRSaAAAAAAA0g5","created":"2026-05-20T10:00:00Z","createdBy":"00uxqCAJWWGELFTYADMI","lastUpdated":"2026-05-22T15:00:00Z","lastUpdatedBy":"00uxqCAJWWGELFTYADMI","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:saml:0oafxqCAJWWGELFTYASJ","mode":"ENABLED","defaultAction":"ACCEPT","additiveAction":"REJECT","_links":{"self":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/config/0oafxqCAJWWGELFTYASJ"},"resource":{"href":"https://example.okta.com/api/v1/apps/0oafxqCAJWWGELFTYASJ"}}},"summary":"Enabled, accepting removals but rejecting additions"},"components/examples/entitlement-reconciliation-config-disabled-example":{"id":"components/examples/entitlement-reconciliation-config-disabled-example","value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:saml:0oafxqCAJWWGELFTYASJ","mode":"DISABLED","_links":{"self":{"href":"https://example.okta.com/governance/api/v1/reconciliation/entitlements/config/0oafxqCAJWWGELFTYASJ"},"resource":{"href":"https://example.okta.com/api/v1/apps/0oafxqCAJWWGELFTYASJ"}}},"summary":"Not configured (disabled by default)","description":"The resource exists, but has no saved reconciliation configuration, so reconciliation is off. The audit fields and actions are omitted."},"components/examples/entitlement-reconciliation-config-writable-example":{"id":"components/examples/entitlement-reconciliation-config-writable-example","value":{"mode":"ENABLED","defaultAction":"ACCEPT"},"summary":"Turn on reconciliation and accept everything","description":"Enables reconciliation and accepts every drift, except a removal from a birthright source, which is always conflict-rejected."},"components/examples/entitlement-reconciliation-config-asymmetric-example":{"id":"components/examples/entitlement-reconciliation-config-asymmetric-example","value":{"mode":"ENABLED","defaultAction":"ACCEPT","additiveAction":"REJECT","subtractiveAction":"ACCEPT"},"summary":"Accept removals, reject additions","description":"Accepts entitlements removed directly in the app, but rejects entitlements added there without going through Okta."},"components/examples/principal-entitlements-success":{"id":"components/examples/principal-entitlements-success","value":{"data":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}]},"summary":"Principal entitlements","description":"When a user has been granted some License and Role entitlement's to Salesforce"},"components/examples/principal-entitlements-change-success":{"id":"components/examples/principal-entitlements-change-success","value":{"entitlementsChanged":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description","changeType":"ADDED"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description","changeType":"REMOVED"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fu190Eg75a8g6","name":"C label","externalValue":"C","description":"C label description","changeType":"ADDED"},{"id":"ent4rg7fltWSgrlDT8g6","name":"D label","externalValue":"D","description":"D label description","changeType":"ADDED"}]},{"id":"espo3v6xlwdtEX2il1d6","name":"Role","externalValue":"Role","description":"Role entitlement property","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Admin access","externalValue":"admin","description":"provides admin access role","changeType":"REMOVED"}]},{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","description":"This is an Approval Payments Role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment","description":"Approve Payment description","changeType":"REMOVED"}]}],"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","principal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"_links":{"principal-entitlements":{"href":"https://myorg.okta.com/governance/api/v1/principal-entitlements?filter=string"}}},"summary":"Principal entitlement changes"},"components/examples/principal-entitlements-history-success":{"id":"components/examples/principal-entitlements-history-success","value":{"resourceOrn":"orn:okta:idp:00o1kq5LLpmbGnOtz0g4:apps:oidc_client:0oacvetsS5uY0gCzk0g4","resource":{"externalId":"0oacvetsS5uY0gCzk0g4","type":"APPLICATION"},"principalOrn":"orn:okta:directory:00o1kq5LLpmbGnOtz0g4:users:00u1rvrLNphg0QAmP0g4","principal":{"externalId":"00u1rvrLNphg0QAmP0g4","type":"OKTA_USER"},"entitlementHistory":[{"id":"gra1234567890abcdefg","startDate":"2025-05-27T18:02:20Z","endDate":"","lifecycle":"ACTIVE","entitlements":[{"id":"esp50hqELd8zN24EK0g3","name":"kelly1_policy_ent1","externalValue":"kelly1_policy_ent1","description":"Entitlement granted through some policy","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50iPvQe2pCKXLj0g3","name":"value1","externalValue":"value_1","description":"description for value1"},{"id":"ent50jekdX8Pvz7qK0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]},{"id":"esp50kwLEb7dHf6cR0g3","name":"kelly1_bundle_ent1","externalValue":"kelly1_bundle_ent1","description":"Part 1 of Entitlement granted through some bundle","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50liBN3ncpWpyx0g3","name":"value1","externalValue":"value_1","description":"description for value1"}]},{"id":"esp50n7nXZizDH2fI0g3","name":"kelly1_bundle_ent2","externalValue":"kelly1_bundle_ent2","description":"Part 2 of Entitlement granted through some bundle","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50oF2BKwZzmk3U0g3","name":"value1","externalValue":"value_1","description":"description for value1"}]}]},{"id":"gra2345678901bcdefgh","startDate":"2025-05-27T17:46:06Z","endDate":"2025-05-27T18:02:20Z","lifecycle":"INACTIVE","entitlements":[{"id":"esp50hqELd8zN24EK0g3","name":"kelly1_policy_ent1","externalValue":"kelly1_policy_ent1","description":"Entitlement granted through some policy","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50iPvQe2pCKXLj0g3","name":"value1","externalValue":"value_1","description":"description for value1"},{"id":"ent50jekdX8Pvz7qK0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]}]},{"id":"gra3456789012cdefghi","startDate":"2025-05-27T16:43:54Z","endDate":"2025-05-27T17:46:06Z","lifecycle":"INACTIVE","entitlements":[{"id":"esp50bptAmBbN6NQD0g3","name":"kelly1_ent2","externalValue":"kelly1_ent2","description":"Some entitlements 2","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50dFEGSm6ULsws0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]},{"id":"esp50hqELd8zN24EK0g3","name":"kelly1_policy_ent1","externalValue":"kelly1_policy_ent1","description":"Entitlement granted through some policy","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50iPvQe2pCKXLj0g3","name":"value1","externalValue":"value_1","description":"description for value1"},{"id":"ent50jekdX8Pvz7qK0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]}]}],"_links":{"self":{"href":"https://oig-admin.okta1.com/governance/api/v1/principal-entitlements-history?filter=resource.externalId%20eq%20%220oacvetsS5uY0gCzk0g4%22%20AND%20resource.type%20eq%20%22APPLICATION%22%20AND%20principal.externalId%20eq%20%2200u1rvrLNphg0QAmP0g4%22%20AND%20principal.type%20eq%20%22OKTA_USER%22&startTime=2023-10-22T20%3A36%3A31Z&limit=3&include=count","hints":{}},"next":{"href":"https://oig-admin.okta1.com/governance/api/v1/principal-entitlements-history?filter=resource.externalId%20eq%20%220oacvetsS5uY0gCzk0g4%22%20AND%20resource.type%20eq%20%22APPLICATION%22%20AND%20principal.externalId%20eq%20%2200u1rvrLNphg0QAmP0g4%22%20AND%20principal.type%20eq%20%22OKTA_USER%22&startTime=2023-10-22T20%3A36%3A31Z&limit=3&include=count&after=gray6L71iX6NduVhm0g2","hints":{}}},"metadata":{"total":4}},"summary":"Principal entitlements history"},"components/examples/principal-access-success-base-and-additional-example":{"id":"components/examples/principal-access-success-base-and-additional-example","value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"expirationTime":"2024-05-31T23:59:59Z","timeZone":"America/Toronto","base":{"grantType":"POLICY","grantMethod":"POLICY","expirationTime":"2024-05-31T23:59:59Z","grant":{"id":"grab0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNR"}}},"entitlements":[{"id":"espfxqCAJWWGELFTYASJ","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Read access","externalValue":"read","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}]}]},"additional":[{"grantType":"ENTITLEMENT-BUNDLE","grantMethod":"ACCESS_REQUEST","startTime":"2024-03-15T00:00:00Z","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","grant":{"id":"grab0oNGTSWTBKOLGLNQ","self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNQ"}},"bundle":{"id":"enb4aHwGLtZBsLSf40g2","name":"Bundle1"},"entitlements":[{"id":"espfxqCAJWWGELFTYASI","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAB","name":"Write access","externalValue":"write","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAB"}]}]}]},"summary":"Principal access data with base and additional entitlements","description":"Principal access data with base (POLICY or CUSTOM) and any additional entitlements"},"components/examples/principal-access-success-base-example":{"id":"components/examples/principal-access-success-base-example","value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"expirationTime":"2024-05-31T23:59:59Z","timeZone":"America/Toronto","base":{"grantType":"POLICY","grantMethod":"POLICY","expirationTime":"2024-05-31T23:59:59Z","grant":{"id":"grab0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNR"}}},"entitlements":[{"id":"espfxqCAJWWGELFTYASJ","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Read access","externalValue":"read","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}]}]}},"summary":"Principal access data with base entitlements only","description":"Principal access data with base (POLICY or CUSTOM) entitlements only"},"components/examples/principal-access-success-no-grants-example":{"id":"components/examples/principal-access-success-no-grants-example","value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"}},"summary":"Principal access data with no entitlements","description":"Principal access data with no entitlements"},"components/examples/principal-access-success-base-metadata-example":{"id":"components/examples/principal-access-success-base-metadata-example","value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"expirationTime":"2024-05-31T23:59:59Z","timeZone":"America/Toronto","base":{"grantType":"POLICY","grantMethod":"POLICY","expirationTime":"2024-05-31T23:59:59Z","grant":{"id":"grab0oNGTSWTBKOLGLNR","metadata":{"collection":{"id":"00cb0oNGTSWTBKOLGLNR","name":"Some Collection"}},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNR"}}},"entitlements":[{"id":"espfxqCAJWWGELFTYASJ","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Read access","externalValue":"read","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}]}]}},"summary":"Principal access data with base entitlements and grant metadata","description":"Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata"},"components/examples/indirect-access-list-example":{"id":"components/examples/indirect-access-list-example","value":{"data":[{"grant":{"id":"grab0oNGTSWTBKOLGLNX","principal":{"externalId":"00gb0oNGTSWTBKOLGLNR","type":"APP_GROUP"}},"scopedEntitlements":[{"resourceAssetId":"reabedEn8JSMRY5MK0g2","resourceAsset":{"id":"reabedEn8JSMRY5MK0g2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:resource-assets:reabedEn8JSMRY5MK0g2","type":{"id":"ret1o5jmfBTZUCzcW0g5","displayName":"Accounts"},"name":"Production Account"},"entitlements":[{"id":"espfxqCAJWWGELFTYASI","name":"PermissionSet","externalValue":"permissionset","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAC","name":"ReadOnlyAccess","externalValue":"read","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAC"}]}]}]},{"grant":{"id":"grab0oNGTSWTBKOLGLNY","principal":{"externalId":"00gb0oNGTSWTBKOLGLNS","type":"APP_GROUP"}},"scopedEntitlements":[{"resourceAssetId":"rea2o6kmgCUAAbdX1g6h","resourceAsset":{"id":"rea2o6kmgCUAAbdX1g6h","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:resource-assets:rea2o6kmgCUAAbdX1g6h","type":{"id":"ret2o6kmgCUAAbdX1g6h","displayName":"Accounts"},"name":"Development Account"},"entitlements":[{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"role","multiValue":false,"required":true,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAD","name":"ViewerRole","externalValue":"viewer","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAD"}]}]}]}],"_links":{"self":{"href":"https://{myOktaDomain}/governance/api/v1/principal-access/indirect?filter=parentResourceOrn%20eq%20%22orn%3Aokta%3Aidp%3A00o11edPwGqbUrsDm0g4%3Aapps%3Aoidc%3A0oafxqCAJWWGELFTYASJ%22%20AND%20targetPrincipalOrn%20eq%20%22orn%3Aokta%3Adirectory%3A00o11edPwGqbUrsDm0g4%3Ausers%3A00ub0oNGTSWTBKOLGLNR%22"}}},"summary":"Indirect access response","description":"Example response for listing indirect access grants"},"components/examples/principal-access-policy-enable-creatable-example":{"id":"components/examples/principal-access-policy-enable-creatable-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","mergeExistingEntitlements":true},"summary":"Enable policy","description":"Request body for enabling policy"},"components/examples/principal-access-policy-no-merge-response-example":{"id":"components/examples/principal-access-policy-no-merge-response-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"effectiveEntitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","externalId":"esp5zFLCIUV7Vibro0g2","description":"A label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xmkviXCltm1d6"}]}],"entitlementAccessDetails":[{"assignmentObjectType":"Entitlement","assignmentMethod":"Policy","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","externalId":"esp5zFLCIUV7Vibro0g2","description":"A label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xmkviXCltm1d6"}]}],"accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"grant":{"id":"0ggb0oNGTSWTBKOMAEST"}}]},"summary":"Enable without merge"},"components/examples/principal-access-policy-merge-response-example":{"id":"components/examples/principal-access-policy-merge-response-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"effectiveEntitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","externalId":"esp5zFLCIUV7Vibro0g2","description":"A label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","externalId":"esp81PLbVQGWaklZb0g2","description":"B label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xk6nOq7lm51d6"}]}],"entitlementAccessDetails":[{"assignmentObjectType":"Entitlement","assignmentMethod":"Policy","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","externalId":"esp5zFLCIUV7Vibro0g2","description":"A label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xmkviXCltm1d6"}]}],"accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"grant":{"id":"0ggb0oNGTSWTBKOMAEST"}},{"assignmentObjectType":"Entitlement","assignmentMethod":"Api","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","externalId":"esp81PLbVQGWaklZb0g2","description":"B label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xk6nOq7lm51d6"}]}],"accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"grant":{"id":"0ggb0oNGTSWTBKOLGLNR"}}]},"summary":"Enable with merge"},"components/examples/principal-access-policy-merge-with-bundle-response-example":{"id":"components/examples/principal-access-policy-merge-with-bundle-response-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"effectiveEntitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","externalId":"esp5zFLCIUV7Vibro0g2","description":"A label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","externalId":"esp81PLbVQGWaklZb0g2","description":"B label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","externalId":"esd5zGLEIUV9Vibro5a9","description":"C label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6"}]}],"entitlementAccessDetails":[{"assignmentObjectType":"Entitlement","assignmentMethod":"Policy","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","externalId":"esp5zFLCIUV7Vibro0g2","description":"A label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xmkviXCltm1d6"}]}],"accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"grant":{"id":"0ggb0oNGTSWTBKOMAEST"}},{"assignmentObjectType":"Bundle","assignmentObject":{"id":"enbo3j1lwErh6dn701d6","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","name":"Admin bundle","description":"Bundle for administrative access"},"assignmentMethod":"AccessRequest","entitlements":[{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"grant":{"id":"0ggb0oNGTSWTBKOAZKWC"}},{"assignmentObjectType":"Entitlement","assignmentMethod":"Api","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","externalId":"esp81PLbVQGWaklZb0g2","description":"B label description","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ento3v6xk6nOq7lm51d6"}]}],"accessDuration":{"expirationTime":"2022-11-24T14:15:22Z","timezone":"America/Toronto"},"grant":{"id":"0ggb0oNGTSWTBKOLGLNR"}}]},"summary":"Enable with merge and existing bundle"},"components/examples/principal-access-policy-enable-missing-required-field":{"id":"components/examples/principal-access-policy-enable-missing-required-field","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /requiredField/0 must cannot be null","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"enablePolicy","errorSummary":"must have required field","location":"/requiredField/","locationType":"body","reason":"REQUIRED_PROPERTY_MISSING"}]},"description":"When the requiredField is missing"},"components/examples/entitlement-settings-em-disabled-example":{"id":"components/examples/entitlement-settings-em-disabled-example","value":{"status":"OPTED_OUT"},"summary":"Entitlement management disabled for a resource","description":"Entitlement management disabled for a resource"},"components/examples/entitlement-settings-em-enabled-example":{"id":"components/examples/entitlement-settings-em-enabled-example","value":{"status":"OPTED_IN"},"summary":"Entitlement management enabled for a resource","description":"Entitlement management enabled for a resource"},"components/examples/entitlement-settings-updatable-opted-in-example":{"id":"components/examples/entitlement-settings-updatable-opted-in-example","value":{"status":"OPTED_IN"},"summary":"Opt in the resource","description":"Updates entitlement settings to opt in the resource to entitlement management feature"},"components/examples/entitlement-settings-updatable-opted-out-example":{"id":"components/examples/entitlement-settings-updatable-opted-out-example","value":{"status":"OPTED_OUT"},"summary":"Opt out the resource","description":"Updates entitlement settings to opt the resource out of entitlement management"},"components/examples/grant-principal-access-entitlement-example":{"id":"components/examples/grant-principal-access-entitlement-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:amazon_aws_sso:0oafxqCAJWWGELFTYASJ","actor":"ACCESS_REQUEST","accessDuration":{"expirationTime":"2025-12-31T23:59:59Z","timezone":"America/Los_Angeles"},"entitlementData":{"type":"ENTITLEMENT","entitlements":[{"resourceAssetOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:resource-assets:reafxqCAJWWGELFTYASJ","entitlementValueOrns":["orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1o5jo0bHpxiDVJ0g5","orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4"]}],"accessDuration":{"expirationTime":"2025-06-30T23:59:59Z","timezone":"UTC"}}},"summary":"Grant with resource-scoped entitlements","description":"Grants a user access to an app with resource-scoped entitlements."},"components/examples/grant-principal-access-bundle-example":{"id":"components/examples/grant-principal-access-bundle-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4","actor":"ACCESS_REQUEST","accessDuration":{"expirationTime":"2025-12-31T23:59:59Z","timezone":"America/Los_Angeles"},"entitlementData":{"type":"ENTITLEMENT_BUNDLE","entitlementBundleOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enb1o5jmfBTZUCzcW0g5","accessDuration":{"expirationTime":"2025-06-30T23:59:59Z","timezone":"UTC"}}},"summary":"Grant with entitlement bundle","description":"Grants a principal access to an app using an entitlement bundle."},"components/examples/grant-principal-access-app-with-duration-example":{"id":"components/examples/grant-principal-access-app-with-duration-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4","actor":"ACCESS_REQUEST","accessDuration":{"expirationTime":"2025-12-31T23:59:59Z","timezone":"America/Los_Angeles"}},"summary":"Grant app access with duration (no entitlements)","description":"Grants a user time-bound access to an app without specifying any entitlements.\nThe access expires at the specified time."},"components/examples/grant-principal-access-minimal-example":{"id":"components/examples/grant-principal-access-minimal-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4","actor":"ACCESS_REQUEST"},"summary":"Minimal grant (app access only)","description":"Grants a user access to an app without specifying entitlements or access duration.\nThis is the simplest form of the request, granting only app-level access."},"components/examples/grant-principal-access-response-example":{"id":"components/examples/grant-principal-access-response-example","value":{"_links":{"principalAccess":{"href":"https://{myOktaDomain}/governance/api/v1/principal-access?filter=targetPrincipalOrn eq \"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4\" and parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4\""}}},"summary":"Successful grant principal access response"},"components/examples/revoke-principal-access-all-app-example":{"id":"components/examples/revoke-principal-access-all-app-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"ADMIN","revokeOrns":["orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:oidc_client:0oa251e7jQHXVgg5r0g4"]},"summary":"Revoke access to a single app"},"components/examples/revoke-principal-access-multiple-entitlements-example":{"id":"components/examples/revoke-principal-access-multiple-entitlements-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"API","revokeOrns":["orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent65J1scEgrRZbjT0g2","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent76K2tdFhsSAcku1h3"]},"summary":"Revoke access to multiple entitlement values"},"components/examples/revoke-principal-access-bundles-example":{"id":"components/examples/revoke-principal-access-bundles-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"ADMIN","revokeOrns":["orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-bundles:enbjpz6MOxd2rUgyh0g3","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-bundles:enbkqz7NPye3sVhzi1h4"]},"summary":"Revoke access to multiple entitlement bundles"},"components/examples/revoke-principal-access-mixed-example":{"id":"components/examples/revoke-principal-access-mixed-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"API","revokeOrns":["orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent65J1scEgrRZbjT0g2","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent76K2tdFhsSAcku1h3","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-bundles:enbjpz6MOxd2rUgyh0g3"]},"summary":"Revoke access to entitlement values and bundles"},"components/examples/revoke-principal-access-response-example":{"id":"components/examples/revoke-principal-access-response-example","value":{"data":[{"_links":{"principal-access":{"href":"https://myorg.okta.com/governance/api/v1/principal-access?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"principal-entitlements":{"href":"https://myorg.okta.com/governance/api/v1/principal-entitlements?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""}}},{"_links":{"principal-access":{"href":"https://myorg.okta.com/governance/api/v1/principal-access?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"principal-entitlements":{"href":"https://myorg.okta.com/governance/api/v1/principal-entitlements?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""}}}]},"summary":"Successful revocation response"},"components/examples/revoke-principal-access-missing-required-field":{"id":"components/examples/revoke-principal-access-missing-required-field","value":{"errorCode":"E0000001","errorSummary":"Api validation failed","errorLink":"E0000001","errorId":"oae12345","errorCauses":[{"errorSummary":"principalOrn is required"}]},"summary":"Missing required field"},"components/examples/revoke-principal-access-invalid-orn":{"id":"components/examples/revoke-principal-access-invalid-orn","value":{"errorCode":"E0000001","errorSummary":"Api validation failed","errorLink":"E0000001","errorId":"oae12345","errorCauses":[{"errorSummary":"Invalid ORN format for revokeObjectOrns"}]},"summary":"Invalid ORN format"},"components/examples/revoke-external-user-entitlement-multiple-entitlements-example":{"id":"components/examples/revoke-external-user-entitlement-multiple-entitlements-example","value":{"principal":"jdoe@example.com","actor":"API","revokeOrns":["orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent65J1scEgrRZbjT0g2","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent76K2tdFhsSAcku1h3"]},"summary":"Revoke multiple entitlement values from an unmanaged user"},"components/examples/revoke-external-user-entitlement-missing-required-field":{"id":"components/examples/revoke-external-user-entitlement-missing-required-field","value":{"errorCode":"E0000001","errorSummary":"Api validation failed","errorLink":"E0000001","errorId":"oae12345","errorCauses":[{"errorSummary":"principal is required"}]},"summary":"Missing required field"},"components/examples/revoke-external-user-entitlement-invalid-orn":{"id":"components/examples/revoke-external-user-entitlement-invalid-orn","value":{"errorCode":"E0000001","errorSummary":"Api validation failed","errorLink":"E0000001","errorId":"oae12345","errorCauses":[{"errorSummary":"Invalid ORN format for revokeOrns"}]},"summary":"Invalid ORN format"},"components/examples/collections-list-example":{"id":"components/examples/collections-list-example","value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736435","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736435","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc5472336736435/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc34657643674534/resources"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections?limit=3&after=rc34657643674534"},"self":{"href":"example.com/governance/api/v1/collections?limit=3"}},"metadata":{"total":3}},"summary":"Collections list","description":"List of collections"},"components/examples/collections-list-with-counts-example":{"id":"components/examples/collections-list-with-counts-example","value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers'","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","counts":{"principalAssignmentCount":10,"resourceCounts":{"APPLICATION":5}},"_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736435","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736435","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","counts":{"principalAssignmentCount":28,"resourceCounts":{"APPLICATION":8}},"_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc5472336736435/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","counts":{"principalAssignmentCount":1,"resourceCounts":{"APPLICATION":3}},"_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc34657643674534/resources"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections?limit=3&after=rc34657643674534"},"self":{"href":"example.com/governance/api/v1/collections?limit=3"}},"metadata":{"total":3}},"summary":"Collections list with counts","description":"List of collections with counts"},"components/examples/collection-creatable-example":{"id":"components/examples/collection-creatable-example","value":{"name":"Core Engineering Access","description":"Birthright access for all FTE engineers"},"summary":"New empty collection","description":"Request body for creating a new resource collection"},"components/examples/collection-full-example":{"id":"components/examples/collection-full-example","value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"summary":"Collection details","description":"Full response details for a resource collection"},"components/examples/collection-updatable-example":{"id":"components/examples/collection-updatable-example","value":{"name":"Core Engineering Access","description":"Birthright access for all FTE engineers"},"summary":"Replaces a resource collection","description":"The request body to replace a resource collection"},"components/examples/collection-resources-list-example":{"id":"components/examples/collection-resources-list-example","value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"summary":"List collection resources","description":"List of resources in a collection"},"components/examples/collection-resources-list-with-counts-example":{"id":"components/examples/collection-resources-list-with-counts-example","value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":2,"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":0,"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":3,"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"summary":"List collection resources with entitlement value counts","description":"List of resources in a collection with entitlement value counts"},"components/examples/collection-resources-list-with-entitlements-example":{"id":"components/examples/collection-resources-list-with-entitlements-example","value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"summary":"List collection resources with entitlements","description":"List of resources in a collection with additional entitlement info"},"components/examples/collection-resources-list-with-counts-and-entitlements-example":{"id":"components/examples/collection-resources-list-with-counts-and-entitlements-example","value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":2,"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":0,"entitlements":[],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha/"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":3,"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste/"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"summary":"List collection resources with entitlement value counts and entitlements","description":"List of resources in a collection with additional entitlement info"},"components/examples/resource-orn-wrong-type":{"id":"components/examples/resource-orn-wrong-type","value":{"errorCode":"E0000028","errorSummary":"Resource ORN must be a specific app","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The resource ORN must be a specific app.","reason":"INVALID_RESOURCE_ORN","locationType":"body","location":"resourceOrn","domain":"collection"}]},"description":"Resource ORN other than a specific app"},"components/examples/list-catalog-users-response-example":{"id":"components/examples/list-catalog-users-response-example","value":{"data":[{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/collections/{collectionId}/catalog/users?filter=firstName%20sw%20%22Juan%22"}}},"summary":"List of unassigned users from a collection","description":"List of unassigned users from a collection"},"components/examples/list-collection-assignments-response-example":{"id":"components/examples/list-collection-assignments-response-example","value":{"data":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/collections/{collectionId}/assignments"}}},"summary":"List of assigned principals to collection","description":"List of assigned principals to collection"},"components/examples/add-principals-to-collection-example":{"id":"components/examples/add-principals-to-collection-example","value":[{"actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto"},{"actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"}}],"summary":"Assign principals to the collection","description":"Assign principals to the collection. The assignment can be for a limited time or indefinite."},"components/examples/add-principals-to-collection-response-example":{"id":"components/examples/add-principals-to-collection-response-example","value":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL"},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"assignmentType":"INDIVIDUAL"}],"summary":"List of assigned principals to collection","description":"List of assigned users to a collection"},"components/examples/patch-add-assignment-expiration":{"id":"components/examples/patch-add-assignment-expiration","value":[{"op":"ADD","path":"/expirationTime","value":"2024-04-30T23:59:59Z"},{"op":"ADD","path":"/timeZone","value":"America/Toronto"}],"summary":"Add - Add an expiration time and time zone","description":"Request body for adding an expiration time and time zone"},"components/examples/patch-update-assignment-expiration":{"id":"components/examples/patch-update-assignment-expiration","value":[{"op":"REPLACE","path":"/expirationTime","value":"2024-04-30T23:59:59Z"},{"op":"REPLACE","path":"/timeZone","value":"America/Toronto"}],"summary":"Update - Replace an expiration time and time zone","description":"Request body for replacing an expiration time and time zone"},"components/examples/patch-remove-assignment-expiration":{"id":"components/examples/patch-remove-assignment-expiration","value":[{"op":"REMOVE","path":"/expirationTime"},{"op":"REMOVE","path":"/timeZone"}],"summary":"Remove - Remove an expiration time and time zone","description":"Request body for removing an expiration time and timezone"},"components/examples/collections-list-example-v2":{"id":"components/examples/collections-list-example-v2","value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736FzMx0g3","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736FzMx0g3","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/col5472336736FzMx0g3/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/col4a6Rpz3FCxDEBp0g3/resources"}}}],"_links":{"next":{"href":"example.com/governance/api/v2/collections?limit=3&after=col4a6Rpz3FCxDEBp0g3"},"self":{"href":"example.com/governance/api/v2/collections?limit=3"}},"metadata":{"total":3}},"summary":"Collections list","description":"List of collections"},"components/examples/collections-list-with-resource-relationship-example":{"id":"components/examples/collections-list-with-resource-relationship-example","value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","resourceRelationship":{"resourceOrn":"orn:okta:idp:00o1234567890:apps:0oa1234567890","addedToCollectionDate":"2024-08-15T10:30:00Z"},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","resourceRelationship":{"resourceOrn":"orn:okta:idp:00o1234567890:apps:0oa1234567890","addedToCollectionDate":"2024-09-01T08:00:00Z"},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/col4a6Rpz3FCxDEBp0g3/resources"}}}],"_links":{"self":{"href":"example.com/governance/api/v2/collections?filter=resourceOrn%20eq%20%22orn%3Aokta%3Aidp%3A00o1234567890%3Aapps%3A0oa1234567890%22"}},"metadata":{"total":2}},"summary":"Collections list filtered by resourceOrn","description":"List of collections containing a specific resource with resource relationship details"},"components/examples/collections-list-with-principal-assignment-example":{"id":"components/examples/collections-list-with-principal-assignment-example","value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","principalAssignment":{"principalOrn":"orn:okta:idp:00o1234567890:users:00u1234567890","actor":"ADMIN","assignmentType":"INDIVIDUAL","expirationTime":"2025-12-31T23:59:59Z"},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736435","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736435","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","principalAssignment":{"principalOrn":"orn:okta:idp:00o1234567890:users:00u1234567890","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","expirationTime":null},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/col5472336736435/resources"}}}],"_links":{"self":{"href":"example.com/governance/api/v2/collections?filter=principalOrn%20eq%20%22orn%3Aokta%3Aidp%3A00o1234567890%3Ausers%3A00u1234567890%22"}},"metadata":{"total":2}},"summary":"Collections list filtered by principalOrn","description":"List of collections assigned to a specific principal with assignment details"},"components/examples/collection-full-example-v2":{"id":"components/examples/collection-full-example-v2","value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"summary":"Collection details","description":"Full response details for a resource collection"},"components/examples/collection-resources-list-with-all-types-example":{"id":"components/examples/collection-resources-list-with-all-types-example","value":{"data":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION"},"resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"resourceProfile":{"id":"0oa4z5j8pzVrBCFYt0g7","name":"workday","label":"Workday","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"resourceProfile":{"id":"0oaXYZ123ABC456DEF78","name":"slack","label":"Slack","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"resourceProfile":{"id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP"},"resourceProfile":{"id":"00gABCDEFGHIJKL12345","name":"Engineering Team","description":"All users in the engineering department","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs6grpiconABC","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources?limit=5"}},"metadata":{"count":5}},"summary":"List collection resources with various types","description":"List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups)."},"components/examples/collection-resources-list-with-all-types-include-counts-example":{"id":"components/examples/collection-resources-list-with-all-types-include-counts-example","value":{"data":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION","counts":{"entitlements":5}},"resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"pushGroups":2}},"resourceProfile":{"id":"0oa4z5j8pzVrBCFYt0g7","name":"workday","label":"Workday","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"resourceProfile":{"id":"0oaXYZ123ABC456DEF78","name":"slack","label":"Slack","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"resourceProfile":{"id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP"},"resourceProfile":{"id":"00gABCDEFGHIJKL12345","name":"Engineering Team","description":"All users in the engineering department","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs6grpiconABC","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources?include=counts&limit=5"}},"metadata":{"count":5}},"summary":"List collection resources with various types with counts"},"components/examples/collection-resource-list-add-apps-creatable-example":{"id":"components/examples/collection-resource-list-add-apps-creatable-example","value":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}]},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7"},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6"}],"summary":"Add apps with entitlements and apps with push groups to a collection"},"components/examples/collection-resource-list-add-groups-creatable-example":{"id":"components/examples/collection-resource-list-add-groups-creatable-example","value":[{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345"}],"summary":"Add groups and push groups to a collection"},"components/examples/collection-resource-list-with-mixed-types-creatable-example":{"id":"components/examples/collection-resource-list-with-mixed-types-creatable-example","value":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7"},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345"}],"summary":"Add resources with various types to a collection","description":"A single API request adding multiple resource types (apps, groups, push groups) to a collection"},"components/examples/add-resources-response-with-mixed-types-example":{"id":"components/examples/add-resources-response-with-mixed-types-example","value":{"data":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6","resourceId":"resPG002def","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG002def","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources?limit=6"}},"metadata":{"count":6}},"summary":"Add resources with various types","description":"Response after adding various types of resources (apps, groups, push groups) to a collection"},"components/examples/collection-resource-app-with-entitlements-bare-response-example":{"id":"components/examples/collection-resource-app-with-entitlements-bare-response-example","value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION","counts":{"entitlements":2}},"entitlements":[{"id":"esp1d9eM0jbeX6n1v0g4","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent1d9fRafZpFimYB0g4","name":"value1","externalValue":"value_1","description":"description for value1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9fRafZpFimYB0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"},{"id":"ent1d9gvE68cz2zCZ0g4","name":"value2","externalValue":"value_2","description":"description for value2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role Entitlement","externalValue":"role_entitlement","description":"Some role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"admin","externalValue":"admin","description":"Administrator role","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}},"entitlements":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements"}}},"summary":"Collection resource app with entitlements","description":"Response showing an app resource with entitlements"},"components/examples/collection-resource-app-with-entitlements-response-example":{"id":"components/examples/collection-resource-app-with-entitlements-response-example","value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION","counts":{"entitlements":2,"labels":2}},"resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[{"id":"esp1d9eM0jbeX6n1v0g4","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent1d9fRafZpFimYB0g4","name":"value1","externalValue":"value_1","description":"description for value1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9fRafZpFimYB0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"},{"id":"ent1d9gvE68cz2zCZ0g4","name":"value2","externalValue":"value_2","description":"description for value2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role Entitlement","externalValue":"role_entitlement","description":"Some role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"admin","externalValue":"admin","description":"Administrator role","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"red"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}},"entitlements":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements"}}},"summary":"Collection resource app with entitlements (include=resourceProfile&include=labels)"},"components/examples/collection-resource-app-with-pushgroups-bare-response-example":{"id":"components/examples/collection-resource-app-with-pushgroups-bare-response-example","value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"pushGroups":2}},"pushGroups":[{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resfHy1wVVOfgFzhh0g1","id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6","resourceId":"resVpQ3nRkZbYt7m2Xa9","id":"00g4rg7fkom0c3AsX8g6","name":"Sales East","description":"Sales team for East region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs3lmnopqRSTUV","type":"image/png"}]}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},"summary":"Collection resource app with push groups","description":"Response showing an app resource with push groups"},"components/examples/collection-resource-app-with-pushgroups-response-example":{"id":"components/examples/collection-resource-app-with-pushgroups-response-example","value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"pushGroups":2,"labels":1}},"pushGroups":[{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resfHy1wVVOfgFzhh0g1","id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6","resourceId":"resVpQ3nRkZbYt7m2Xa9","id":"00g4rg7fkom0c3AsX8g6","name":"Sales East","description":"Sales team for East region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs3lmnopqRSTUV","type":"image/png"}]}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},"summary":"Collection resource app with push groups (include=labels)"},"components/examples/collection-resource-app-response-example":{"id":"components/examples/collection-resource-app-response-example","value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"labels":1}},"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},"summary":"Collection resource direct app (include=labels)"},"components/examples/collection-resource-pushgroup-bare-response-example":{"id":"components/examples/collection-resource-pushgroup-bare-response-example","value":{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},"summary":"Collection resource push group","description":"Response showing a push group resource"},"components/examples/collection-resource-pushgroup-response-example":{"id":"components/examples/collection-resource-pushgroup-response-example","value":{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP","counts":{"relatedApps":3,"labels":1}},"relatedApps":[{"id":"0oa4z5j8pzVrBCFYt0g7","name":"workday","label":"Workday","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}],"inCollection":true},{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}],"inCollection":true},{"id":"0oaSN789servicenow12","name":"servicenow","label":"ServiceNow","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs5snowiconXYZ","type":"image/png"}],"inCollection":false}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},"summary":"Collection resource push group (include=labels&include=relatedApps)"},"components/examples/collection-resource-group-response-example":{"id":"components/examples/collection-resource-group-response-example","value":{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP","counts":{"relatedApps":3,"labels":1}},"relatedApps":[{"id":"0oaJIRA456jiraApp123","name":"jira","label":"Jira","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs7jiraiconDEF","type":"image/png"}],"inCollection":true},{"id":"0oaGH789githubApp123","name":"github","label":"GitHub","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs8ghiconGHI","type":"image/png"}],"inCollection":false},{"id":"0oaXYZ123ABC456DEF78","name":"slack","label":"Slack","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs4wxyzABCDEF","type":"image/png"}],"inCollection":false}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"red"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}},"summary":"Collection resource group (include=labels&include=relatedApps)"},"components/examples/collection-resource-entitlements-list-example":{"id":"components/examples/collection-resource-entitlements-list-example","value":{"data":[{"id":"esp1d9eM0jbeX6n1v0g4","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent1d9fRafZpFimYB0g4","name":"value1","externalValue":"value_1","description":"description for value1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9fRafZpFimYB0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"},{"id":"ent1d9gvE68cz2zCZ0g4","name":"value2","externalValue":"value_2","description":"description for value2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role Entitlement","externalValue":"role_entitlement","description":"Some role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"admin","externalValue":"admin","description":"Administrator role","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements?limit=20"}},"metadata":{"total":2}},"summary":"List of entitlements for a collection resource","description":"Response showing the paginated list of entitlements for an app resource in a collection"},"components/examples/list-catalog-users-response-example-v2":{"id":"components/examples/list-catalog-users-response-example-v2","value":{"data":[{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v2/collections/{collectionId}/catalog/users?filter=firstName%20sw%20%22Juan%22"}}},"summary":"List of unassigned users from a collection","description":"List of unassigned users from a collection"},"components/examples/list-collection-assignments-response-example-v2":{"id":"components/examples/list-collection-assignments-response-example-v2","value":{"data":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v2/collections/{collectionId}/assignments"}}},"summary":"List of assigned principals to collection","description":"List of assigned principals to collection"},"components/examples/list-risk-rule-response-example":{"id":"components/examples/list-risk-rule-response-example","value":{"data":[{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","status":"ACTIVE","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"lastUpdated":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules/rulb0oNGTSWTBKOLGLNR"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules?limit=2"},"next":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules?limit=2&after=rulb0oNGTSWTBKOLGLNR"}},"metadata":{"total":10}},"summary":"List risk rule response"},"components/examples/create-risk-rule-request-example":{"id":"components/examples/create-risk-rule-request-example","value":{"name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","values":[{"id":"ento3v6xk6nOq7lm51d6"}]}]}}]}},"summary":"Create risk rule request"},"components/examples/risk-rule-response-example":{"id":"components/examples/risk-rule-response-example","value":{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","status":"ACTIVE","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"lastUpdated":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules/rulb0oNGTSWTBKOLGLNR"}}},"summary":"Risk rule response"},"components/examples/duplicate-name":{"id":"components/examples/duplicate-name","value":{"errorCode":"E0000028","errorSummary":"Rule name needs to be unique","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The rule name needs to be unique.","reason":"INVALID_RULE_NAME","locationType":"body","location":"name","domain":"rules"}]},"description":"Duplicate rule name"},"components/examples/update-risk-rule-request-example":{"id":"components/examples/update-risk-rule-request-example","value":{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","notes":"Process and Approve Payment note","description":"Process and Approve Payment","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","values":[{"id":"ento3v6xk6nOq7lm51d6"}]}]}}]}},"summary":"Update risk rule request"},"components/examples/bundle-request-risk-assessment-example":{"id":"components/examples/bundle-request-risk-assessment-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"},"summary":"Risk assessment for bundle request"},"components/examples/collection-request-risk-assessment-example":{"id":"components/examples/collection-request-risk-assessment-example","value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:col28w6vzKKultXP98g5"},"summary":"Risk assessment for collection request"},"components/examples/risk-assessment-response-example":{"id":"components/examples/risk-assessment-response-example","value":{"data":[{"id":"gra1ogjm4Osoj1ztg0g3:rulb0oNGTSWTBKOLGLNR","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","ruleName":"Process and Approve Payment","ruleId":"rulb0oNGTSWTBKOLGLNR","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":{"data":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/rules/rulb0oNGTSWTBKOLGLNR"}}},{"id":"gra1ogjm4Osoj1ztg0g3:rulb0oNGTSWTBKOLGLNR","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","ruleName":"Process and Approve Payment","ruleId":"rulb0oNGTSWTBKOLGLNR","description":"License and Approve","type":"SEPARATION_OF_DUTIES","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"License Role","externalValue":"license_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Approve Payment","externalValue":"license"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approve Role","externalValue":"approve_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Process License","externalValue":"process_license"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/rules/rulb0oNGTSWTBKOLGLNQ"}}}],"_links":{"href":"https://myorg.okta.com/governance/api/v1/risk-rule-assessments?limit=20"}},"summary":"List of risk-rule conflicts for a specific resource","description":"A list of risk-rule conflicts"},"components/examples/resource-owners-list-response-example":{"id":"components/examples/resource-owners-list-response-example","value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}},{"id":"pri6yl0Q065H4BCPR0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4","profile":{"id":"00u6yl0Q065H4BCPR0g4","email":"someother.name@okta.com","name":"Some Other Name","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u6yl0Q065H4BCPR0g4"}}}}]},{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"entn4WFkzQJhB6QIa0g1","type":"entitlement-values","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entn4WFkzQJhB6QIa0g1","profile":{"id":"entn4WFkzQJhB6QIa0g1","name":"License Entitlement value 1","description":"Some license entitlement value","parent":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement"}}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":2},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]},{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enb1spaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enb1spaj3XUzcM62u1d6","profile":{"id":"enb1spaj3XUzcM62u1d6","name":"Github sub bundle","description":"Github sub for administrative access"}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":5},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners?limit=20&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\""}},"metadata":{"total":10}},"summary":"Resource owners list success response"},"components/examples/resource-owners-list-with-parent-app-owner-response-example":{"id":"components/examples/resource-owners-list-with-parent-app-owner-response-example","value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}},{"id":"pri6yl0Q065H4BCPR0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4","profile":{"id":"00u6yl0Q065H4BCPR0g4","email":"someother.name@okta.com","name":"Some Other Name","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u6yl0Q065H4BCPR0g4"}}}}]},{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"res1spaj3XUzcM62u1d6","type":"apps","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","profile":{"id":"0oafxqCAJWWGELFTYASJ"}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":10},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners?limit=20&include=parent_resource_owner&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\""}},"metadata":{"total":10}},"summary":"Resource owners list success with parent resource owner included response"},"components/examples/resource-owners-ai-agent-list-response-example":{"id":"components/examples/resource-owners-ai-agent-list-response-example","value":{"data":[{"resource":{"id":"wlp1tgwssMI9jYizU0g5","type":"ai-agents","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp1tgwssMI9jYizU0g5","profile":{"id":"wlp1tgwssMI9jYizU0g5","name":"My AI Agent","description":"An AI agent for automating workflows"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}}]},{"resource":{"id":"wlp2tgwssMI9jYizU0g5","type":"ai-agents","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp2tgwssMI9jYizU0g5","profile":{"id":"wlp2tgwssMI9jYizU0g5","name":"Another AI Agent","description":"An AI agent for processing data pipelines"}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":3},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners?limit=20&filter=resource.type eq \"ai-agents\""}},"metadata":{"total":2}},"summary":"Resource owners list success response for AI agents"},"components/examples/resource-owners-users-request-example":{"id":"components/examples/resource-owners-users-request-example","value":{"principalOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4"],"resourceOrns":["orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"]},"summary":"Create or update resource owners users request"},"components/examples/resource-owners-group-request-example":{"id":"components/examples/resource-owners-group-request-example","value":{"principalOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4"],"resourceOrns":["orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"]},"summary":"Create or update resource owners group request"},"components/examples/resource-owners-delete-request-example":{"id":"components/examples/resource-owners-delete-request-example","value":{"principalOrns":null,"resourceOrns":["orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"]},"summary":"Delete all resource owners request"},"components/examples/resource-owners-ai-agent-request-example":{"id":"components/examples/resource-owners-ai-agent-request-example","value":{"principalOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"],"resourceOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp1tgwssMI9jYizU0g5"]},"summary":"Create or update resource owners for an AI agent"},"components/examples/resource-owners-users-response-example":{"id":"components/examples/resource-owners-users-response-example","value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}},{"id":"pri6yl0Q065H4BCPR0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4","profile":{"id":"00u6yl0Q065H4BCPR0g4","email":"someother.name@okta.com","name":"Some Other Name","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u6yl0Q065H4BCPR0g4"}}}}]}]},"summary":"Create or update resource owners users response"},"components/examples/resource-owners-group-response-example":{"id":"components/examples/resource-owners-group-response-example","value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":3},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}]},"summary":"Create or update resource owners group response"},"components/examples/resource-owners-delete-response-example":{"id":"components/examples/resource-owners-delete-response-example","value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":null}]},"summary":"Delete all resource owners response"},"components/examples/resource-owners-ai-agent-response-example":{"id":"components/examples/resource-owners-ai-agent-response-example","value":{"data":[{"resource":{"id":"wlp1tgwssMI9jYizU0g5","type":"ai-agents","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp1tgwssMI9jYizU0g5","profile":{"id":"wlp1tgwssMI9jYizU0g5","name":"My AI Agent","description":"An AI agent for automating workflows"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}}]}]},"summary":"Create or update resource owners for an AI agent response"},"components/examples/resource-owners-patch-request-example":{"id":"components/examples/resource-owners-patch-request-example","value":{"resourceOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","data":[{"op":"REMOVE","path":"/principalOrn","value":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u20sfroCwbHQO4a0g"},{"op":"REMOVE","path":"/principalOrn","value":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g"}]},"summary":"Create or update resource owners request"},"components/examples/resource-owners-catalog-resources-response-example":{"id":"components/examples/resource-owners-catalog-resources-response-example","value":{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","data":[{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},{"id":"enb1spaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enb1spaj3XUzcM62u1d6","profile":{"id":"enb1spaj3XUzcM62u1d6","name":"Github sub bundle","description":"Github sub for administrative access"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners/catalog/resources?limit=20&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\""}}},"summary":"Resource owners entitlement bundle catalog success response"},"components/examples/resource-owners-ent-values-catalog-resources-response-example":{"id":"components/examples/resource-owners-ent-values-catalog-resources-response-example","value":{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","data":[{"id":"entn5KFkzQJhB6QIa0g1","type":"entitlement-values","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entn5KFkzQJhB6QIa0g1","profile":{"id":"entn5KFkzQJhB6QIa0g1","name":"License Entitlement value 1","description":"Some license entitlement value 1","parent":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement"}}},{"id":"entn4WFkzQJhB6QIa0g1","type":"entitlement-values","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entn4WFkzQJhB6QIa0g1","profile":{"id":"entn4WFkzQJhB6QIa0g1","name":"License Entitlement value 2","description":"Some license entitlement value 2","parent":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners/catalog/resources?limit=20&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.profile.parent.id eq \"esp2lr1lavoGDYw5U8g6\" AND resource.type eq \"entitlement-values\""}}},"summary":"Resource owners entitlement values catalog success response"},"components/examples/list-labels-response-example":{"id":"components/examples/list-labels-response-example","value":{"data":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}}],"_links":{"self":{"href":"/governance/api/v1/labels"}}},"summary":"List labels response"},"components/examples/create-label-request-example":{"id":"components/examples/create-label-request-example","value":{"name":"Compliance","values":[{"name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}]},"summary":"Create a resource label request"},"components/examples/label-response-example":{"id":"components/examples/label-response-example","value":{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}},"summary":"Label response"},"components/examples/patch-label-update-category-example":{"id":"components/examples/patch-label-update-category-example","value":[{"op":"REPLACE","path":"/name","value":"Compliance","refType":"LABEL-CATEGORY"}],"summary":"Update label category","description":"Request body for updating label category"},"components/examples/patch-label-add-value-example":{"id":"components/examples/patch-label-add-value-example","value":[{"op":"ADD","path":"/values/-","value":{"name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}},"refType":"LABEL-VALUE"}],"summary":"Update - add new label value","description":"Request body for adding label value"},"components/examples/patch-label-remove-value-example":{"id":"components/examples/patch-label-remove-value-example","value":[{"op":"REMOVE","path":"/values/lblo3v6xlwdtEX2il1d1","refType":"LABEL-VALUE"}],"summary":"Update - remove label value","description":"Request body for removing label value"},"components/examples/patch-label-update-value-example":{"id":"components/examples/patch-label-update-value-example","value":[{"op":"REPLACE","path":"/values/lblo3v6xlwdtEX2il1d1/name","value":{"name":"PII"},"refType":"LABEL-VALUE"},{"op":"REPLACE","path":"/values/lblo3v6xlwdtEX2il1d1/metadata/additionalProperties/backgroundColor","value":{"metadata":{"additionalProperties":{"backgroundColor":"blue"}}},"refType":"LABEL-VALUE"}],"summary":"Update - update label value","description":"Request body for updating label value"},"components/examples/list-resource-labels-response-example":{"id":"components/examples/list-resource-labels-response-example","value":{"data":[{"orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","profile":{"id":"0oafxqCAJWWGELFTYASJ","name":"Github application","description":"Github application"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]}],"_links":{"self":{"href":"/governance/api/v1/resource-labels?filter=orn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""}}},"summary":"List resources with labels response"},"components/examples/assign-resources-labels-example":{"id":"components/examples/assign-resources-labels-example","value":{"resourceOrns":["orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:cologpaj3XUzcM62u1d6","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent63C22YQoNMWOJf0g2"],"labelValueIds":["lblo3v6xlwdtEX2il1d1","lblo3v6xlwdtEX2il1d2"]},"summary":"Assign resource labels example"},"components/examples/assign-resource-labels-response-example":{"id":"components/examples/assign-resource-labels-response-example","value":{"data":[{"orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","profile":{"id":"0oafxqCAJWWGELFTYASJ","name":"Github application","description":"Github application"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]},{"orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Github user group","description":"Github user group"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]},{"orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]},{"orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:cologpaj3XUzcM62u1d6","profile":{"id":"cologpaj3XUzcM62u1d6","name":"DevOps collection","description":"Collection of DevOps resources"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]}]},"summary":"List resources with labels response"},"components/examples/unassign-resources-labels-example":{"id":"components/examples/unassign-resources-labels-example","value":{"resourceOrns":["orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:cologpaj3XUzcM62u1d6","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent63C22YQoNMWOJf0g2"],"labelValueIds":["lblo3v6xlwdtEX2il1d2"]},"summary":"Unassign resources labels example"},"components/examples/settings-with-delegate":{"id":"components/examples/settings-with-delegate","value":{"delegates":{"appointments":[{"delegate":{"type":"OKTA_USER","externalId":"00u2lxfQaw8WRlkQt0g4"},"note":"Johnny Appleseed is on parental leave"}]}},"summary":"Admin-appointed delegate"},"components/examples/settings-with-no-delegate":{"id":"components/examples/settings-with-no-delegate","value":{"delegates":{"appointments":[]}},"summary":"No delegate appointment"},"components/examples/principal-settings-patch-with-delegates":{"id":"components/examples/principal-settings-patch-with-delegates","value":{"delegates":{"appointments":[{"id":"gda123ABCXYZ456DEF","delegate":{"type":"OKTA_USER","externalId":"00u2lxfQaw8WRlkQt0g4"},"note":"Johnny Appleseed is on parental leave","created":"2025-08-08T14:15:22Z","createdBy":"00u2lxfQaw8WRlkQt0g4","lastUpdated":"2025-08-28T14:15:22Z","lastUpdatedBy":"00u2lxfQaw8WRlkQt0g4"}]}},"summary":"A delegate appointment"},"components/examples/settings-patch-missing-fields":{"id":"components/examples/settings-patch-missing-fields","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Governance settings missing required fields","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Governance settings is missing required fields"}]},"summary":"Missing required fields"},"components/examples/settings-patch-invalid-properties":{"id":"components/examples/settings-patch-invalid-properties","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Governance settings has invalid properties","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Governance settings has invalid properties: delegator"}]},"summary":"Invalid properties in the settings request"},"components/examples/delegates-get-success":{"id":"components/examples/delegates-get-success","value":{"data":[{"id":"gda123ABCXYZ456DEF","delegate":{"type":"OKTA_USER","externalId":"00ub0oNGTSWTBKOLGLNR"},"delegator":{"type":"OKTA_USER","externalId":"00ub0oNGTSWTBKOLAAAA"},"note":"Johnny Appleseed is on parental leave","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR"},{"id":"gda123ABCXYZ456DEF","delegate":{"type":"OKTA_USER","externalId":"00u109dSBQX9e9XYS0g4"},"delegator":{"type":"OKTA_USER","externalId":"00u2lxfQaw8WRlkQt0g4"},"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-28T14:15:22Z","note":"Mary Lamb is on holiday","created":"2019-08-24T14:15:22Z","createdBy":"00u2lxfQaw8WRlkQt0g4","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00u2lxfQaw8WRlkQt0g4"}],"_links":{"self":{"href":"https://subdomain.okta.com/governance/api/v1/settings/delegates"}}},"summary":"Delegate appointments"},"components/examples/no-delegates-get-success":{"id":"components/examples/no-delegates-get-success","value":{"data":[],"_links":{"self":{"href":"https://subdomain.okta.com/governance/api/v1/settings/delegates"}}},"summary":"User has no delegates"},"components/examples/org-settings-delegates-enduser-read-write":{"id":"components/examples/org-settings-delegates-enduser-read-write","value":{"delegates":{"enduser":{"permissions":["WRITE"]}}},"summary":"All end users have write access and can edit their delegates"},"components/examples/org-settings-delegates-enduser-read-only":{"id":"components/examples/org-settings-delegates-enduser-read-only","value":{"delegates":{"enduser":{"permissions":["READ"]}}},"summary":"All end users have read-only access and can view their delegates"},"components/examples/org-settings-delegates-escalations":{"id":"components/examples/org-settings-delegates-escalations","value":{"delegates":{"enduser":{"permissions":["READ"]}},"escalations":{"accessRequests":{"endUserCanEscalate":true}}},"summary":"Governance settings for delegates and access request escalations"},"components/examples/org-settings-delegates-enduser-write-manager-only":{"id":"components/examples/org-settings-delegates-enduser-write-manager-only","value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"}]}}},"summary":"End users can only assign their manager as a delegate"},"components/examples/org-settings-delegates-enduser-write-manager-peers":{"id":"components/examples/org-settings-delegates-enduser-write-manager-peers","value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"},{"type":"PEERS"}]}}},"summary":"End users can assign their manager or peers as delegates"},"components/examples/org-settings-integrations-in-progress":{"id":"components/examples/org-settings-integrations-in-progress","value":{"data":[{"id":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","status":"IN_PROGRESS"}]},"summary":"List integrations in progress"},"components/examples/org-settings-integrations-connected":{"id":"components/examples/org-settings-integrations-connected","value":{"data":[{"id":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","status":"CONNECTED"}]},"summary":"List integrations connected"},"components/examples/org-settings-integrations-failed":{"id":"components/examples/org-settings-integrations-failed","value":{"data":[{"id":"goi5a4b3c2d1e9f8g7h6","type":"SLACK","status":"FAILED"}]},"summary":"List integrations failed"},"components/examples/org-settings-integration-write":{"id":"components/examples/org-settings-integration-write","value":{"type":"SLACK"},"summary":"Create Slack integration"},"components/examples/org-settings-integration-in-progress-read":{"id":"components/examples/org-settings-integration-in-progress-read","value":{"id":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","status":"IN_PROGRESS","_links":{"authUrl":{"href":"https://slack.com/oauth/v2/authorize?client_id=XXXX&scope=channels:read,chat:write,commands,users:read&state=XXXX"}}},"summary":"Slack integration in progress"},"components/examples/org-certification-settings-get-notifications-enabled":{"id":"components/examples/org-certification-settings-get-notifications-enabled","value":{"integrations":{"settings":[{"integrationId":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","notifications":{"enabled":true}}]}},"summary":"Notifications are enabled for all supported integrations"},"components/examples/org-certification-settings-notifications-patchable-example":{"id":"components/examples/org-certification-settings-notifications-patchable-example","value":{"integrations":{"settings":[{"integrationId":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","notifications":{"enabled":true}}]}},"summary":"Certification notification settings for the org"},"components/examples/find-resource-owner-candidates":{"id":"components/examples/find-resource-owner-candidates","value":{"data":[{"externalId":"00u1a2b3c4d5e6f7g8h1","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h1"},{"externalId":"00u1a2b3c4d5e6f7g8h2","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h2"},{"externalId":"00u1a2b3c4d5e6f7g8h3","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h3","delegator":{"type":"OKTA_USER","externalId":"00u1a2b3c4d5e6f7g8h4","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h4"}}]},"summary":"Find resource owner candidates"},"components/examples/find-resource-owner-candidates-excluding-specific-users":{"id":"components/examples/find-resource-owner-candidates-excluding-specific-users","value":{"data":[{"externalId":"00u1a2b3c4d5e6f7g8h2","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h2"},{"externalId":"00u1a2b3c4d5e6f7g8h3","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h3","delegator":{"type":"OKTA_USER","externalId":"00u1a2b3c4d5e6f7g8h4","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h4"}}]},"summary":"Find resource owner candidates while excluding 00u1a2b3c4d5e6f7g8h1"},"components/examples/find-resource-owner-candidates-skip-resolving-owning-groups-to-members":{"id":"components/examples/find-resource-owner-candidates-skip-resolving-owning-groups-to-members","value":{"data":[{"externalId":"00u1a2b3c4d5e6f7g8h1","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h1"},{"externalId":"00g5a4b3c2d1e9f8g7h5","type":"OKTA_GROUP","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:group:00g5a4b3c2d1e9f8g7h5"}]},"summary":"Find resource owner candidates with skipResolvingOwningGroupsToMembers=true"},"components/examples/find-resource-owner-candidates-groups-only-after-excluding-users":{"id":"components/examples/find-resource-owner-candidates-groups-only-after-excluding-users","value":{"data":[{"externalId":"00g5a4b3c2d1e9f8g7h5","type":"OKTA_GROUP","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:group:00g5a4b3c2d1e9f8g7h5"}]},"summary":"Find resource owner candidates with skipResolvingOwningGroupsToMembers=true while excluding 00u1a2b3c4d5e6f7g8h1"},"components/examples/find-resource-owner-candidates-skip-delegate-replacement":{"id":"components/examples/find-resource-owner-candidates-skip-delegate-replacement","value":{"data":[{"externalId":"00u1a2b3c4d5e6f7g8h1","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h1"},{"externalId":"00u1a2b3c4d5e6f7g8h2","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h2"},{"externalId":"00u1a2b3c4d5e6f7g8h4","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h4"}]},"summary":"Find resource owner candidates with skipDelegateReplacement=true"},"components/examples/find-resource-owner-candidates-limit-1":{"id":"components/examples/find-resource-owner-candidates-limit-1","value":{"data":[{"externalId":"00u1a2b3c4d5e6f7g8h1","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u1a2b3c4d5e6f7g8h1"}]},"summary":"Find resource owners candidates with limit=1"},"components/examples/find-group-member-candidates":{"id":"components/examples/find-group-member-candidates","value":{"data":[{"externalId":"00u2b3c4d5e6f7g8h9i0","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u2b3c4d5e6f7g8h9i0"},{"externalId":"00u2b3c4d5e6f7g8h9i1","type":"OKTA_USER","orn":"orn:okta:directory:00o1a2b3c4d5e6f7g8h9:user:00u2b3c4d5e6f7g8h9i1"}]},"summary":"Find group member candidates"},"components/examples/find-group-member-candidates-empty":{"id":"components/examples/find-group-member-candidates-empty","value":{"data":[]},"summary":"Find group member candidates but group is empty"},"components/examples/missing-type":{"id":"components/examples/missing-type","value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The type parameter is required.","reason":"MISSING_REQUIRED_PARAMETER","locationType":"query","location":"/type","domain":"governance"}]},"summary":"When type parameter is missing"},"components/examples/missing-entity-id":{"id":"components/examples/missing-entity-id","value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The entityId parameter is required.","reason":"MISSING_REQUIRED_PARAMETER","locationType":"query","location":"/entityId","domain":"governance"}]},"summary":"When entityId parameter is missing"},"components/examples/invalid-type":{"id":"components/examples/invalid-type","value":{"errorCode":"E0000001","errorSummary":"API validation failed.","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid value for type parameter.","reason":"INVALID_ENUM_VALUE","locationType":"query","location":"/type","domain":"governance"}]},"summary":"When type parameter is invalid"},"components/examples/invalid-skip-resolving-owning-groups-to-members-for-group-member":{"id":"components/examples/invalid-skip-resolving-owning-groups-to-members-for-group-member","value":{"errorCode":"E0000001","errorSummary":"Api validation failed: skipResolvingOwningGroupsToMembers is only applicable when type=RESOURCE_OWNER.","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw"},"summary":"When skipResolvingOwningGroupsToMembers parameter is invalid"},"components/examples/get-all-sars-to-be-reviewed":{"id":"components/examples/get-all-sars-to-be-reviewed","value":{"data":[{"id":"sar1qebJYYHgbsOGF0g4","status":"ACTIVE","name":"Test SAR","endTime":"2025-06-20T14:55:27Z","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"],"includedUserProfiles":[{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE"},{"id":"00ucpjbi6JMmDvdN40g5","email":"jane.doe@okta.com","firstName":"Jane","lastName":"Doe","login":"jane.doe@okta.com","status":"ACTIVE"}]}},"createdBy":"00uco2uaXN7POnPUw0g4","created":"2025-06-13T14:55:28Z","lastUpdated":"2025-06-13T14:55:28Z","lastUpdatedBy":"00uco2uaXN7POnPUw0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4","hints":{}},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/history","hints":{}},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/accesses","hints":{}},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/actions","hints":{}},"principalDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/principal","hints":{}}}}],"_links":{"self":{"href":"https://ogrhmzrmnditnmfjys00otqylthhnjgtm2zhy2i1m2qxzwy4-admin.okta1.com/governance/api/v2/my/security-access-reviews?limit=20","hints":{}}}},"summary":"Lists all security access reviews based on filter criteria"},"components/examples/sar-create-success-request":{"id":"components/examples/sar-create-success-request","value":{"principalId":"00ucpjbi6JMmDvdN40g4","name":"Test SAR","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"]}}},"summary":"Payload to create a security access review"},"components/examples/sar-get-details-success-response":{"id":"components/examples/sar-get-details-success-response","value":{"id":"sar1lo5X9wmNTFX7x0g4","status":"PENDING","name":"Test SAR","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"],"includedUserProfiles":[{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE"},{"id":"00ucpjbi6JMmDvdN40g5","email":"jane.doe@okta.com","firstName":"Jane","lastName":"Doe","login":"jane.doe@okta.com","status":"ACTIVE"}]}},"createdBy":"00ucfd4IQoH6YBZgA0g4","created":"2025-06-13T00:40:57Z","lastUpdated":"2025-06-13T00:40:57Z","lastUpdatedBy":"00ucfd4IQoH6YBZgA0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4"},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/history"},"userDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/user"},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/accesses"},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/actions"}}},"summary":"Create a security access review response"},"components/examples/get-all-sars-stats":{"id":"components/examples/get-all-sars-stats","value":{"activeCount":1,"pendingCount":0,"errorCount":0,"closedCount":0},"summary":"Statistics for all security access reviews"},"components/examples/sar-update-success-request":{"id":"components/examples/sar-update-success-request","value":{"endTime":"2025-12-31T23:59:59Z","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"]}}},"summary":"Payload to update a security access review"},"components/examples/get-ai-summary-success":{"id":"components/examples/get-ai-summary-success","value":{"message":"This app's overall priority is: High\nThe reasons why this app was assigned priority of High include:\n1. Usage history (HIGH): The user has not accessed this application in the last 90 days.\n2. Assignment method (HIGH): This user's assignment method differs from 75% of other users who have access to this application.\n"},"summary":"Generate a security access review summary response"},"components/examples/get-ai-summary-error":{"id":"components/examples/get-ai-summary-error","value":{"message":"We couldn't generate a summary based on the available data. Please try again later.\n","errors":[{"errorCode":"summary.generator.not.available","errorMsg":"Summary generator is unable to generate summary based on available data. Report this error to customer support."}]},"summary":"Failed to generate a summary for a security access review"},"components/examples/sar-get-applicable-actions":{"id":"components/examples/sar-get-applicable-actions","value":{"data":[{"actionType":"CLOSE_REVIEW"},{"actionType":"RESTORE_ALL_ACCESS"}]},"summary":"All possible actions for a security access review response"},"components/examples/sar-get-user-principal-details-success-response":{"id":"components/examples/sar-get-user-principal-details-success-response","value":{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE","department":"Engineering","manager":"Jane Smith","role":"Software Engineer","homeLocation":{"city":"San Francisco","state":"CA","country":"USA"},"lastLoginInfo":{"date":"2025-06-12T15:30:00Z","location":{"city":"San Francisco","state":"CA","country":"USA"},"device":"MacBook Pro","ipAddress":"127.0.0.1"},"oktaAdminRoles":[{"roleId":"00uabc12345XYZ67890","roleName":"Super Admin"}],"createdBy":"00ucfd4IQoH6YBZgA0g4","created":"2025-06-13T00:40:57Z","lastUpdated":"2025-06-13T00:40:57Z","lastUpdatedBy":"00ucfd4IQoH6YBZgA0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4"},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/history"},"userDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/user"},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/accesses"},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/actions"}}},"summary":"Target principal of a security access review response"},"components/examples/sar-get-accesses-success-response":{"id":"components/examples/sar-get-accesses-success-response","value":{"data":[{"id":"aim1pmincO6RY9SYC0g4","type":"APPLICATION","name":"App 2 Assigned By Group","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"appInfo":{"id":"0oacmnh7uyRdOpCdg0g4","name":"TEST: Secure Password Store","logoUrl":"http://myorg.okta.com/assets/img/logos/okta-logo-black.e4851b6e6f17df0565a0f2a3f56086f1.png","label":"App 2 Assigned By Group","assignedDate":"2025-06-13T14:23:23Z","assignmentType":"GROUP","applicationUsage":0},"subAccessTypes":["GROUP"]},{"id":"aim1pmjGO1ACFhkxp0g4","type":"APPLICATION","name":"App 1 No Groups","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"appInfo":{"id":"0oacmmurqSIOjNwS90g4","name":"TEST: Secure Password Store","logoUrl":"http://myorg.okta.com/assets/img/logos/okta-logo-black.e4851b6e6f17df0565a0f2a3f56086f1.png","label":"App 1 No Groups","assignedDate":"2025-06-13T14:23:22Z","assignmentType":"INDIVIDUAL","applicationUsage":0}},{"id":"aim1pmkobz1YkJx5N0g4","type":"APPLICATION","name":"App 3 With Entitlements","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"appInfo":{"id":"0oacmo5Hj3n1YOhiK0g4","name":"TEST: Secure Password Store","logoUrl":"http://myorg.okta.com/assets/img/logos/okta-logo-black.e4851b6e6f17df0565a0f2a3f56086f1.png","label":"App 3 With Entitlements","assignedDate":"2025-06-13T14:23:35Z","assignmentType":"INDIVIDUAL","applicationUsage":0,"activeEntitlements":[{"id":"esp1pkp0iVReYgtKU0g4","name":"unbnaovmin","description":"unbnaovmin Description"},{"id":"esp1pldLMJdOb9qI30g4","name":"nozoxxcqiu","description":"nozoxxcqiu Description"},{"id":"esp1plgThoMotdYWU0g4","name":"xpfgzmfhop","description":"xpfgzmfhop Description"}]},"subAccessTypes":["ENTITLEMENT"]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1pmdmaK6ZaAuix0g4/accesses?limit=20&orderBy=priority%20desc"}}},"summary":"List access items in a security access review response"},"components/examples/sar-get-sub-accesses-success-response":{"id":"components/examples/sar-get-sub-accesses-success-response","value":{"data":[{"id":"sai1pml8QCT3vGZco0g4","name":"unbnaovmin: value1","type":"ENTITLEMENT","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"entitlementInfo":{"type":"ENTITLEMENT_VALUE","description":"value 1 description","entitlementDescription":"unbnaovmin Description","assignmentType":"INDIVIDUAL","collectionsAssigning":[],"entitlements":[],"governanceLabels":[]}},{"id":"sai1pmmQFzxZreP1L0g4","name":"unbnaovmin: value2","type":"ENTITLEMENT","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"entitlementInfo":{"type":"ENTITLEMENT_VALUE","description":"value 2 description","entitlementDescription":"unbnaovmin Description","assignmentType":"INDIVIDUAL","collectionsAssigning":[],"entitlements":[],"governanceLabels":[]}},{"id":"sai1pmngWq0n4IGFi0g4","name":"test bundleaotsw","type":"ENTITLEMENT","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"entitlementInfo":{"type":"ENTITLEMENT_BUNDLE","description":"test bundle ...","assignmentType":"ACCESS_REQUEST","collectionsAssigning":[],"entitlements":[{"id":"esp1pldLMJdOb9qI30g4","name":"nozoxxcqiu","description":"nozoxxcqiu Description"},{"id":"esp1plgThoMotdYWU0g4","name":"xpfgzmfhop","description":"xpfgzmfhop Description"}],"governanceLabels":[]}}],"_links":{"self":{"href":"https://myorg.okta1.com/governance/api/v2/my/security-access-reviews/sar1pmdmaK6ZaAuix0g4/accesses/aim1pmkobz1YkJx5N0g4/sub-accesses?limit=20&orderBy=priority%20desc","hints":{}}}},"summary":"List of sub-access items response"},"components/examples/sar-get-all-anomalies-success-response":{"id":"components/examples/sar-get-all-anomalies-success-response","value":{"data":[{"type":"USAGE_HISTORY","severity":"LOW","subtext":{"message":"The user was assigned the app recently, {0}","args":[{"value":"2025-06-13T15:23:59Z","type":"RELATIVE_DATE_TO_NOW"}]}},{"type":"ASSIGNMENT_METHOD","severity":"LOW","subtext":{"message":"The user was assigned to the group directly, aligning with {0}% of users who were assigned the same way","args":[{"value":"100","type":"NUMBER"}]}},{"type":"PAST_GOVERNANCE_DECISIONS","severity":"LOW","subtext":{"message":"No data found. The assignment has no past governance decisions"}}]},"summary":"Response for access item anomolies"},"components/examples/sar-get-history-details-success-response":{"id":"components/examples/sar-get-history-details-success-response","value":{"data":[{"id":"srh1pmhpjmJ6Oyzzx0g4","systemGenerated":true,"timestamp":"2025-06-13T14:23:35Z","message":"created Test SAR","principalProfile":{"id":"00ucmjraRsXXFRRSK0g4","email":"admin@zwqzmjg4yzetngnimi00nznhlwe2ytmtnzk5ogjjywrkmjyz.com","firstName":"Add-Min","lastName":"O'Cloudy Tud","login":"admin@zwqzmjg4yzetngnimi00nznhlwe2ytmtnzk5ogjjywrkmjyz.com","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta1.com/governance/api/v2/my/security-access-reviews/sar1pmdmaK6ZaAuix0g4/history?limit=20","hints":{}}}},"summary":"History of a security access review response"},"components/examples/get-ai-summary-sse-delta-success":{"id":"components/examples/get-ai-summary-sse-delta-success","value":{"id":"event-12345","event":"DELTA","data":"'{ \"message\": \"This app's overall priority is: High\\nThe reasons are explained below\", \"deltaMessage\": \"explained below\", \"errors\": [] }'\n"},"summary":"Delta security access review summary event in SSE format","description":"A security access review summary is sent with repeated server-sent events (SSE). This example shows a portion of the summary (a delta) in an event stream."},"components/examples/get-ai-summary-sse-end-success":{"id":"components/examples/get-ai-summary-sse-end-success","value":{"id":"event-12345","event":"END","data":"'{ \"message\": \"This app's overall priority is: High\\nThe reasons are explained below\", \"deltaMessage\": \"explained below\", \"errors\": [] }'\n"},"summary":"Last security access review summary event in SSE format","description":"A security access review summary is sent with repeated server-sent events (SSE). This example shows the end of the event stream."},"components/examples/get-ai-summary-sse-error":{"id":"components/examples/get-ai-summary-sse-error","value":{"id":"event-12345","event":"ERROR","data":"'{ \"message\": \"Something went wrong\", \"errors\": [ {\"errorCode\": \"summary.generator.not.available\", \"errorMsg\": \"Unable to generate summary\"} ] }'\n"},"summary":"Error security access review summary event in SSE format","description":"A security access review summary is sent with repeated server-sent events (SSE). This example shows an error event."},"components/examples/operation-running-example":{"id":"components/examples/operation-running-example","value":{"id":"cpa4r1gtPOqBal07j0g5","type":"collection:principal:assignment","status":"RUNNING","created":"2026-01-09T01:25:04.000Z","started":"2026-01-09T01:25:05.208Z","completed":null,"timeElapsedInSeconds":1,"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/operations/cpa4r1gtPOqBal07j0g5"}}},"summary":"Operation in RUNNING status"},"components/examples/resource-inventory-stats-salesforce":{"id":"components/examples/resource-inventory-stats-salesforce","value":{"apps":3,"groups":8,"entitlementValues":21,"entitlementBundles":2,"collections":1},"summary":"Statistics for Salesforce resources","description":"Resource counts per type for resources matching \"Salesforce\" search query"},"components/examples/resource-inventory-list":{"id":"components/examples/resource-inventory-list","value":{"data":[{"id":"res123456","type":"APP","name":"Salesforce","description":"Salesforce CRM App","status":"active","logos":[{"url":"https://example.okta.com/img/salesforce-logo.png"}],"stats":{"apps":1,"users":150,"owners":1,"entitlements":25},"metadata":{"appId":"0oafxqCAJWWGELFTYASJ","integrationName":"salesforce","color":"blue"},"_embedded":{"owners":[{"id":"00ub0oNGTSWTBKOLGLNR","name":"John Doe","metadata":{"type":"USER","email":"john.doe@example.com"}}],"labels":[{"id":"lbco3v6xlwdtEX2il1d6","name":"Compliance","metadata":{"values":[{"id":"lbl49laUP3HQKXTBE0g3","name":"SOX","backgroundColor":"yellow"}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/apps/res123456"},"apps":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/apps/res123456/apps"}}},{"id":"res789012","type":"APP","name":"Salesforce Sandbox","description":"Salesforce Sandbox Environment","status":"active","logos":[{"url":"https://example.okta.com/img/salesforce-logo.png"}],"stats":{"apps":1,"users":45,"owners":1,"entitlements":15},"metadata":{"appId":"0oaAnotherAppId123","integrationName":"salesforce","color":"green"},"_embedded":{"owners":[{"id":"00ub0oNGTSWTBKOLGLNR","name":"John Doe","metadata":{"type":"USER","email":"john.doe@example.com"}}],"labels":[{"id":"lbco3v6xlwdtEX2il1d6","name":"Compliance","metadata":{"values":[{"id":"lbl49laUP3HQKXTBE0g3","name":"SOX","backgroundColor":"yellow"}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/apps/res789012"},"apps":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/apps/res789012/apps"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/apps?filter=name%20sw%20%22Salesforce%22%20AND%20owner.id%20eq%20%2200ub0oNGTSWTBKOLGLNR%22&limit=20"},"next":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/apps?filter=name%20sw%20%22Salesforce%22%20AND%20owner.id%20eq%20%2200ub0oNGTSWTBKOLGLNR%22&limit=20&after=res789012"}},"metadata":{"total":47}},"summary":"Resource inventory list","description":"List of app resources with filtering applied"},"components/examples/resource-inventory-filter-options":{"id":"components/examples/resource-inventory-filter-options","value":{"data":[{"id":"0oafxqCAJWWGELFTYASJ","name":"Salesforce","logo":"https://example.okta.com/img/salesforce-logo.png"},{"id":"0oaAnotherAppId123","name":"Salesforce Sandbox","logo":"https://example.okta.com/img/salesforce-logo.png"},{"id":"0oaSlackAppId456","name":"Slack","logo":"https://example.okta.com/img/slack-logo.png"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/entitlements/filters/apps?filter=name%20sw%20%22Sales%22&limit=20"},"next":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/entitlements/filters/apps?filter=name%20sw%20%22Sales%22&limit=20&after=0oaSlackAppId456"}},"metadata":{"total":12}},"summary":"Filter options for apps","description":"List of app filter options matching search criteria"},"components/examples/resource-inventory-label-filter-options":{"id":"components/examples/resource-inventory-label-filter-options","value":{"data":[{"id":"lbco3v6xlwdtEX2il1d6","name":"Compliance","metadata":{"values":[{"id":"lbl49laUP3HQKXTBE0g3","name":"SOX","backgroundColor":"yellow"},{"id":"lbl49vtZbhwYvDns20g3","name":"PII","backgroundColor":"red"}]}},{"id":"lbco3v6xlwdtEX2il1d7","name":"Security","metadata":{"values":[{"id":"lbl59laUP3HQKXTBE0g3","name":"GDPR","backgroundColor":"blue"}]}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-inventory/entitlements/filters/labels?limit=20"}},"metadata":{"total":2}},"summary":"Filter options for labels","description":"List of label filter options with metadata"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.":{"value":{"campaignType":"RESOURCE","description":"Group Campaign | User Reviewer Expression","name":"Group Campaign | User Reviewer Expression","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T13:43:40.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GROUP","resourceId":"00gg2gzn7m1Aw2zAs1d7"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"reviewerScopeExpression":"user.profile.reviewerId","type":"REVIEWER_EXPRESSION","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"},"reportingSettings":{"createReportingPackageEnabled":true}},"key":"Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","summary":"Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","description":"This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using groups with users as scope |tooltip| This flow creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.":{"value":{"campaignType":"RESOURCE","description":"Group Campaign | User Reviewer Expression | User Expression","name":"Group Campaign | User Reviewer Expression | User Expression","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T13:37:47.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GROUP","resourceId":"00gg2gzn7m1Aw2zAs1d7"}]},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.title==\"Engineer\""},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"reviewerScopeExpression":"user.profile.reviewerId","type":"REVIEWER_EXPRESSION","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","summary":"Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","description":"This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign using group with user expression scope |tooltip| This flow creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.":{"value":{"campaignType":"RESOURCE","description":"App Campaign | User Reviewer | Without Entitlements","name":"App Campaign | User Reviewer | Without Entitlements","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T14:15:23.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":false,"targetResources":[{"resourceType":"APPLICATION","resourceId":"0oa9g0l878boNXWzs1d7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","summary":"Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","description":"This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with users as scope |tooltip| This flow creates a resource campaign that includes users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","summary":"Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","description":"The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"notificationSettings":{"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","summary":"Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","summary":"Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"notificationSettings":{"remindersReviewerBeforeCampaignCloseInSecs":[3600,86400,172800]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","summary":"Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","description":"The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"}},"key":"Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","summary":"Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"key":"Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","summary":"Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has beend taken by assigned reviewer."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"RECURRING","startDate":"2023-05-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P1M","repeatOnType":"SAME_DAY_AS_START_DATE"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"key":"Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.","summary":"Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day.","description":"A recurring campaign that repeats indefinitely every month on the 5th day.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 5th day of the month |tooltip| A recurring campaign that repeats indefinitely every month on the 5th day."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"RECURRING","startDate":"2023-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P3M","repeatOnType":"SAME_WEEKDAY_AS_START_DATE","ends":"2024-07-01T00:00:01.001Z"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"key":"Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","summary":"Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","description":"A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"RESOURCE_OWNER","fallBackReviewerId":"00utewuyetytiuwe"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"key":"Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","summary":"Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","description":"Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group owner |tooltip| Applicable when `resourceSettings.type = GROUP`. One can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"GROUP","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","reviewerGroupId":"irgw7zU9vHVj1ldKx0g2"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"}},"key":"Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","summary":"Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","description":"Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerId":"00u12gpFVIth5WbxT0g4","type":"USER","startReview":{"onDay":0}},{"reviewerId":"00u11knukTc2hYuTC0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"}}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","summary":"Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","description":"Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType USER at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n\nIn this example, the `transitionPolicy` is `APPROVED`. That means only `APPROVED` decisions at first level will go to second level.\nA `REVOKED` decision for any of the reviews in first level is updated as the final decision. Such reviews do not move to second level.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerGroupId":"00g10ukkkcE7g2wvm0g5","type":"GROUP","startReview":{"onDay":0},"selfReviewDisabled":false},{"reviewerGroupId":"irg186ZIbgNfadsPb0g3","type":"GROUP","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":true}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","summary":"Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","description":"Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with reviewerType GROUP at both levels |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nBoth the reviewer levels has `reviewerType = GROUP` with distinct reviewer groups.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"RESOURCE_OWNER","startReview":{"onDay":0},"selfReviewDisabled":true},{"reviewerId":"00u11knsq97GGflac0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","summary":"Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","description":"Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi level campaign with level 1 reviewerType RESOURCE_OWNER and level 2 reviewerType USER |tooltip| Applicable when `reviewerSettings.type = MULTI_LEVEL`.\nReviewer at level1 has `reviewerType = RESOURCE_OWNER` and level2 has `reviewerType = USER`.\nA reviewer at each level will make a decision before the final decision is made on reviews.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of certain users for all their apps and groups","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP"],"individuallyAssignedAppsOnly":false,"individuallyAssignedGroupsOnly":false},"principalScopeSettings":{"type":"USERS","userIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","summary":"User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","description":"Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with specific users and both apps and groups as resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\n\nIn this example, only the `userIds` is selected for review but all apps and groups associated with those users are reviewed.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of certain users for all their apps and groups except excluded resources","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00u12gpFVIth5WbxT0g4","resourceType":"GROUP"},{"resourceId":"00u11knukTc2hYuTC0g5","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","groupIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","summary":"User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","description":"Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign with excluded resources |tooltip| Applicable when `campaignType = USER`.\nspecifies a set of user Ids to review.\nSelects both apps and groups to be reviewed.\nSelects a list of excluded groups and apps.\n\nIn this example, only the `groupIds` is selected for review but all apps and groups associated with those users are reviewed.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of users assigned to apps and its entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementBundles":[{"id":"00gyqjxNrZD11n4w40g3"}],"entitlements":[{"id":"00ub0oNGTSWTBKOLGLNR","includeAllValues":false,"values":[{"id":"entfxqCAJWWGELFTYAAA"},{"id":"00u12gpFVIth5WbxT0g4"}]}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n","summary":"Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n","description":"Applicable when the application has ramp entitlements such as Salesforce or Google.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| Applicable when the application has ramp entitlements such as Salesforce or Google.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n":{"value":{"name":"Review of admin roles","description":"Review all users with an Okta admin role","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"0oa33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":true},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":true,"justificationRequired":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","summary":"Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","description":"The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties to pass when creating a resource-centric campaign on the Okta Admin Console.\nAlso, allows you to specify only active users in the campaign.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"},{"resourceId":"00ayqjxNrZD11n4w40g4"}]},"principalScopeSettings":{"type":"USERS","predefinedInactiveUsersScope":{"inactiveDays":90}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","summary":"Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","description":"The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with predefined inactive users scope |tooltip| The set of properties to pass to create a campaign on users who have been inactive for the past 90 days in a set of applications."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign":{"value":{"name":"Aug 1 - Multi App Campaign","description":"Multi app campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-08-01T10:08:36-07:00","durationInDays":21,"timeZone":"America/Vancouver"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceId":"0oa1d00gtLNtrDEiz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true},{"resourceId":"0oa17a5l4ZgcHbvoz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","summary":"Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","description":"The set of properties received when creating a resource-centric multi app entitlement campaign","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.":{"value":{"name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"},{"resourceId":"00ayqjxNrZD11n4w40g4"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","reassignmentDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY","autoRemediationSettings":{"includeAllIndirectAssignments":false,"includeOnly":[{"type":"GROUP","id":"00gyqjxNrsh764hjs784"},{"type":"GROUP","id":"00glupyvtjRjiYehQ0g4"}]}}},"key":"Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","summary":"Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","description":"The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign defined for applications with group remediation settings |tooltip| The set of properties to pass when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements":{"value":{"campaignType":"RESOURCE","description":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","name":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","scheduleSettings":{"startDate":"2025-03-17T17:20:09.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"onlyIncludeUsersWithSODConflicts":true,"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"bulkDecisionDisabled":true,"reviewerLevels":[{"reviewerId":"00u8emkyb56SK6NNE0g7","startReview":{"onDay":0},"type":"USER"},{"reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":false,"startReview":{"when":"LOWER_LEVEL_APPROVES","onDay":15},"type":"GROUP"}],"justificationRequired":true,"type":"MULTI_LEVEL"},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","summary":"SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","description":"App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts":{"value":{"campaignType":"RESOURCE","description":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","name":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","scheduleSettings":{"startDate":"2025-03-17T17:20:20.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"onlyIncludeUsersWithSODConflicts":false,"userScopeExpression":"user.profile.department==\"Purchasing\" || user.profile.department==\"IT\"","type":"USERS"},"reviewerSettings":{"reviewerScopeExpression":"user.profile.managerId","selfReviewDisabled":true,"justificationRequired":false,"fallBackReviewerId":"00u8emkyb56SK6NNE0g7","type":"REVIEWER_EXPRESSION","bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","summary":"SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","description":"App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts":{"value":{"campaignType":"RESOURCE","description":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","name":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","scheduleSettings":{"startDate":"2025-03-17T17:48:16.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"userScopeExpression":"user.realmId==\"guo8emlxtsLOx3Q1H0g7\"","type":"USERS","onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"reviewerScopeExpression":"user.profile.managerId","selfReviewDisabled":true,"justificationRequired":false,"fallBackReviewerId":"00u8emkyb56SK6NNE0g7","type":"REVIEWER_EXPRESSION","bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","summary":"SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","description":"App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts":{"value":{"campaignType":"RESOURCE","description":"App SOD Campaign | Group Reviewer | Entitlements","name":"App SOD Campaign | Group Reviewer | Entitlements","status":"ACTIVE","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":true},"principalScopeSettings":{"type":"USERS","onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true,"reviewerGroupId":"00g8eubpdlXjtVkql0g7","type":"GROUP"},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","summary":"SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","description":"App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts":{"value":{"campaignType":"RESOURCE","description":"App SOD Campaign | Group Reviewer | User Expression | Entitlements","name":"App SOD Campaign | Group Reviewer | User Expression Entitlements","scheduleSettings":{"startDate":"2025-03-17T18:43:57.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"targetResources":[{"resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true,"resourceId":"0oa8ers0nyoTFEhsc0g7"}],"onlyIncludeOutOfPolicyEntitlements":false},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.department == \"Purchasing\" || user.profile.department == \"IT\"","onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true,"reviewerGroupId":"00g8eubpdlXjtVkql0g7","type":"GROUP"},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","summary":"SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","description":"App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign with targeted apps through governance label values":{"value":{"campaignType":"RESOURCE","description":"App Campaign | Governance Label Values","name":"App Campaign | Governance Label Values","status":"ACTIVE","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":false,"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Governance campaign with targeted apps through governance label values","summary":"Governance campaign with targeted apps through governance label values","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign with targeted apps through governance label values"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign that targets groups through governance label values":{"value":{"campaignType":"RESOURCE","description":"Group Campaign | Governance Label Values","name":"Group Campaign | Governance Label Values","status":"ACTIVE","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Governance campaign that targets groups through governance label values","summary":"Governance campaign that targets groups through governance label values","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Governance campaign that targets groups through governance label values"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels":{"value":{"name":"Entitlement Campaign | Governance Label Values","description":"Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign on an app with entitlements and bundles that are targeted through governance labels","summary":"Campaign on an app with entitlements and bundles that are targeted through governance labels","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels":{"value":{"name":"Application Entitlement Campaign | Governance Label Values","description":"Application Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign on apps with entitlements and bundles that are all targeted through governance labels","summary":"Campaign on apps with entitlements and bundles that are all targeted through governance labels","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying Okta service accounts":{"value":{"name":"Okta Service Account Campaign","description":"Okta Service Account Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["OKTA_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"19a2c9b1-78a0-4bf0-be9a-c064dd1eba3f","resourceType":"OKTA_SERVICE_ACCOUNT"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign certifying Okta service accounts","summary":"Campaign certifying Okta service accounts","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying Okta service accounts"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying SaaS app service accounts":{"value":{"name":"Application Service Accounts Campaign","description":"Application Service Accounts Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APP_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllAppServiceAccounts":false,"appServiceAccounts":[{"id":"98318fba-cff5-4394-b67c-2774b3980aec"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign certifying SaaS app service accounts","summary":"Campaign certifying SaaS app service accounts","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying SaaS app service accounts"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections":{"value":{"name":"Collection Campaign","description":"Collection Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"col2v7TA5ecDXIvhL0g3","resourceType":"COLLECTION"},{"resourceId":"col2w4CdEIDVHTA4L0g3","resourceType":"COLLECTION"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign certifying collections","summary":"Campaign certifying collections","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections using governance label values":{"value":{"name":"Collection Campaign with Governance Label Values","description":"Collection Campaign with Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"lblm6vmyH0RQz9f5k0g4","resourceType":"GOVERNANCE_LABEL_VALUE"},{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign certifying collections using governance label values","summary":"Campaign certifying collections using governance label values","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying collections using governance label values"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n":{"value":{"name":"Monthly access review of sales team","description":"Review access of certain users to all their apps, groups, and collections.","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP","COLLECTION"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00u12gpFVIth5WbxT0g4","resourceType":"GROUP"},{"resourceId":"00u11knukTc2hYuTC0g5","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","groupIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","summary":"User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","description":"Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nApps, groups, and collections are selected for review.\n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n"},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.":{"value":{"campaignType":"RESOURCE","description":"Group Campaign | Justification Required For All","name":"Group Campaign | Justification Required For All","status":"ACTIVE","scheduleSettings":{"startDate":"2024-10-04T13:43:40.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GROUP","resourceId":"00gg2gzn7m1Aw2zAs1d7"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"selfReviewDisabled":true,"justificationRequirement":"REQUIRED_FOR_ALL","type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewPeriodEnd":true,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessRevoked":"DENY","accessApproved":"NO_ACTION","noResponse":"NO_ACTION"},"reportingSettings":{"createReportingPackageEnabled":true}},"key":"Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","summary":"Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","description":"This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions.","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign with justification requirement |tooltip| This flow creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL, requiring reviewers to provide justification for both approve and revoke decisions."},"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n":{"value":{"name":"Monthly access review of AI agent connections","description":"Review access of certain AI agents to all their connected resources.","campaignType":"USER","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["AI_AGENT_CONNECTION"],"individuallyAssignedAppsOnly":false,"individuallyAssignedGroupsOnly":false,"excludedResources":[]},"principalScopeSettings":{"type":"AI_AGENTS","aiAgentIds":["wlpx9jQ16k9V8IFEL0g3","wlpx8kR27j0U7HGDM1h4"]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true}},"key":"Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n","summary":"Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n","description":"Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/requestBody/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| Set `campaignType = USER` for identity campaigns that certify AI agents' connected resources.  \nThis campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.\n"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/launch","hints":{}},"endCampaign":{"href":"https:///myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/end","hints":{}},"reviews":{"href":"https:///myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindtwi8SY3MVP1M1d6%22","hints":{}},"self":{"href":"https:///myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6","hints":{}}},"id":"icindtwi8SY3MVP1M1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T13:43:35Z","lastUpdated":"2024-10-04T13:43:35Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"Group Campaign | User Reviewer Expression","description":"Group Campaign | User Reviewer Expression","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T09:43:40-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T08:43:40-05:00"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gg2gzn7m1Aw2zAs1d7","resourceType":"GROUP","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.reviewerId","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","summary":"Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","description":"The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with users as scope |tooltip| The response from a flow that creates a resource campaign for all users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.":{"value":{"_links":{"launchCampaign":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/campaigns/icindsflgKOT1IpJJ1d6/launch","hints":{}},"endCampaign":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/campaigns/icindsflgKOT1IpJJ1d6/end","hints":{}},"reviews":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindsflgKOT1IpJJ1d6%22","hints":{}},"self":{"href":"https://orgtesting-admin.oktapreview.com/governance/api/v1/campaigns/icindsflgKOT1IpJJ1d6","hints":{}}},"id":"icindsflgKOT1IpJJ1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T13:37:43Z","lastUpdated":"2024-10-04T13:37:43Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"Group Campaign | User Reviewer Expression | User Expression","description":"Group Campaign | User Reviewer Expression | User Expression","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T09:37:47-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T08:37:47-05:00"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gg2gzn7m1Aw2zAs1d7","resourceType":"GROUP","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.title==\"Engineer\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.reviewerId","fallBackReviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","summary":"Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","description":"The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a group with user expression scope |tooltip| The response for a flow that creates a resource campaign for a subset of users assigned to a specific Okta group. A specific user is assigned as the reviewer based on an Okta Expression. If this user isn't resolved, a specific fallback reviewer is used. An Okta Expression is used to select the subset of users in a group."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindto3sXIqOrZla1d6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindto3sXIqOrZla1d6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindto3sXIqOrZla1d6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindto3sXIqOrZla1d6","hints":{}}},"id":"icindto3sXIqOrZla1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T14:15:19Z","lastUpdated":"2024-10-04T14:15:19Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"App Campaign | User Reviewer | Without Entitlements","description":"App Campaign | User Reviewer | Without Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T10:15:23-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T09:15:23-05:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa9g0l878boNXWzs1d7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","summary":"Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","description":"The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app with users as scope |tooltip| The response for a flow that creates a resource campaign including users assigned to a specific application without entitlements. This flow specifies a specific user as the reviewer."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.","summary":"Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.","description":"The set of properties to pass when creating a campaign with reviewer settings and reviewer Id.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer ID |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer Id."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","summary":"Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","description":"The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer scope expression |tooltip| The set of properties to pass when creating a campaign with reviewer settings and reviewer scope expression."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"notificationSettings":{"notifyReviewerAtCampaignEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","summary":"Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign end."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","summary":"Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","description":"The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer notification at campaign assignment |tooltip| The set of properties to pass when creating a campaign with notification settings to notify reviewer at campaign assignment."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"notificationSettings":{"remindersReviewerBeforeCampaignEndInSecs":[3600,600,60]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","summary":"Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","description":"The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer reminders before campaign end |tooltip| The set of properties to pass when creating a campaign with notification settings to send reminders to reviewers before campaign end."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","summary":"Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group on revoke |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when review decision is revoked by assigned reviewer."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.","summary":"Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.","description":"The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with remediation to remove users from group when no decision by reviewer |tooltip| The set of properties to pass when creating a campaign with remediation settings to remove the users from group when no action has been taken by assigned reviewer."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"RECURRING","startDate":"2023-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P1M","repeatOnType":"SAME_DAY_AS_START_DATE"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"title":"For recurring campaign, this will provide a new campaign resource endpoint in the \"Location\" header","href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day.","summary":"Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day.","description":"A recurring campaign that repeats indefinitely every month on the 30th day.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign repeating indefinitely on 30th day of every month |tooltip| A recurring campaign that repeats indefinitely every month on the 30th day."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"RECURRING","startDate":"2023-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P3M","repeatOn":"SAME_WEEKDAY_AS_START_DATE","ends":"2024-07-01T00:00:01.001Z"}},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"title":"For recurring campaign, this will provide a new campaign resource endpoint in the \"Location\" header","href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","summary":"Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","description":"A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Recurring campaign that repeats every 3 months on Thursday of 2nd week |tooltip| A recurring campaign that repeats every 3 months on Thursday of 2nd week and ends after a certain date."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"RESOURCE_OWNER","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","summary":"Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","description":"Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with group owners |tooltip| Applicable when `resourceSettings.type = GROUP`. Once can specify multiple resource Ids.\nEach resource (which is a group), could have owners assigned.\nWhen a campaign is created to review such groups, the reviews would be created for each member of the group. The owners of each of those groups, become reviewer(s) for those reviewers.\n"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"irgw7zU9vHVj1ldKx0g2","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","summary":"Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","description":"Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with reviewer group |tooltip| Applicable when `reviewerSettings.type = GROUP`.\nThe group specified via `reviewerGroupId` could have multiple members.\nEach member of the group will become reviewer(s) of the reviews.\n"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerId":"00u12gpFVIth5WbxT0g4","type":"USER","startReview":{"onDay":0},"selfReviewDisabled":false},{"reviewerId":"00u11knukTc2hYuTC0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","summary":"Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","description":"Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType USER at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerGroupId":"00g10ukkkcE7g2wvm0g5","fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"GROUP","startReview":{"onDay":0},"selfReviewDisabled":false},{"reviewerGroupId":"irg186ZIbgNfadsPb0g3","fallBackReviewerId":"00u11knsq97GGflac0g5","type":"GROUP","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":true}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","summary":"Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","description":"Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType GROUP at both levels |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nBoth the reviewer levels has reviewerType = GROUP\nA reviewer at each level will make a decision before the final decision is made on reviews.\n"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gyqjxNrsh764hjs784"},{"resourceId":"00gyqjxNrsh764hjs784"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"RESOURCE_OWNER","startReview":{"onDay":0},"selfReviewDisabled":true},{"reviewerId":"00u11knsq97GGflac0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES_OR_REJECTS"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","summary":"Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","description":"Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign of multi level type with reviewerType RESOURCE_OWNER at level1 and USER at level2 |tooltip| Applicable when reviewerSettings.type = MULTI_LEVEL.\nReviewer level1 has reviewerType = RESOURCE_OWNER and level2 has reviewerType = USER\nA reviewer at each level will make a decision before the final decision is made on reviews.\n"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to all their apps and groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","summary":"Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","description":"The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["GROUP"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00g1rv27u2TF9nhTw0g4","resourceType":"GROUP"},{"resourceId":"00g1rv4XS9W3Kpdqr0g4","resourceType":"GROUP"},{"resourceId":"0oa15kjDgk1EubTwo0g4","resourceType":"APPLICATION"},{"resourceId":"0oa15kacS7yNOcBoU0g4","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","summary":"Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementBundles":[{"id":"00gyqjxNrZD11n4w40g3"}],"entitlements":[{"id":"00ub0oNGTSWTBKOLGLNR","includeAllValues":false,"values":[{"id":"entfxqCAJWWGELFTYAAA"},{"id":"00u12gpFVIth5WbxT0g4"}]}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","summary":"Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on application with entitlements and bundles |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Review of admin roles","description":"Review all users with an Okta admin role","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"RESOURCE","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"0oa33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":true,"justificationRequired":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console.","summary":"Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console.","description":"The set of properties received when creating a resource-centric campaign on the Okta Admin Console.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on Okta Admin Console |tooltip| The set of properties received when creating a resource-centric campaign on the Okta Admin Console."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"}]},"principalScopeSettings":{"type":"USERS","predefinedInactiveUsersScope":{"inactiveDays":90}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.","summary":"Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.","description":"The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with a app and predefined inactive users scope |tooltip| The set of properties to pass when creating a campaign with resource as a application(s) and principal scope settings as predefined inactive users for past 90 days."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign":{"value":{"id":"ici4dny7lnWXs8oRr8g6","createdBy":"00u29i85Lay3jSRlw8g5","created":"2024-08-01T17:08:36Z","lastUpdated":"2024-08-01T17:08:54Z","lastUpdatedBy":"00u29i85Lay3jSRlw8g5","name":"Aug 1 - Multi App Campaign","description":"Multi app campaign","campaignType":"RESOURCE","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-08-01T10:08:36-07:00","durationInDays":21,"timeZone":"America/Vancouver","endDate":"2024-08-22T10:08:36-07:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa1d00gtLNtrDEiz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true},{"resourceId":"0oa17a5l4ZgcHbvoz8g6","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/campaigns/ici4dny7lnWXs8oRr8g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/campaigns/ici4dny7lnWXs8oRr8g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici4dny7lnWXs8oRr8g6%22","hints":{}},"self":{"href":"https://myorg.okta.com.clouditude.com/governance/api/v1/campaigns/ici4dny7lnWXs8oRr8g6","hints":{}}}},"key":"Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","summary":"Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign","description":"The set of properties received when creating a resource-centric multi app entitlement campaign","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Multi App Entitlement Campaign |tooltip| The set of properties received when creating a resource-centric multi app entitlement campaign"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"00ayqjxNrZD11n4w40g3"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY","autoRemediationSettings":{"includeAllIndirectAssignments":false,"includeOnly":[{"type":"GROUP","id":"00gyqjxNrsh764hjs784"},{"type":"GROUP","id":"00glupyvtjRjiYehQ0g4"}]}},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","summary":"Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","description":"The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with an app and group remediation settings |tooltip| The set of properties received when creating a campaign with an application resource(s) that includes group assignment of users to the application who can be automatically remediated."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdjwBUjRCEsC0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdjwBUjRCEsC0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mdjwBUjRCEsC0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdjwBUjRCEsC0g6","hints":{}}},"id":"icib9mdjwBUjRCEsC0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:20:05Z","lastUpdated":"2025-03-17T17:20:05Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","description":"App SOD Campaign | Multi Level User and Group Reviewers | Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:20:09-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:20:09-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":false},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"type":"USER","startReview":{"onDay":0},"reviewerId":"00u8emkyb56SK6NNE0g7","selfReviewDisabled":false},{"type":"GROUP","startReview":{"onDay":15,"when":"LOWER_LEVEL_APPROVES"},"reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":false}]},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","summary":"SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","description":"App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign with multi-level user and group reviewers |tooltip| App separation of duties (SOD) campaign | Multi-level user and group reviewers | Entitlements"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdlvqVT9YzkZ0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdlvqVT9YzkZ0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mdlvqVT9YzkZ0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mdlvqVT9YzkZ0g6","hints":{}}},"id":"icib9mdlvqVT9YzkZ0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:20:15Z","lastUpdated":"2025-03-17T17:20:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","description":"App SOD Campaign |  Manager Reviewer | User Expression | Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:20:20-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:20:20-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.department==\"Purchasing\" || user.profile.department==\"IT\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":false},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00u8emkyb56SK6NNE0g7","selfReviewDisabled":true,"justificationRequired":false,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","summary":"SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","description":"App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show all users with a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression | Entitlements | Show all users, including any SOD conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9md6vsfZyE7qR0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9md6vsfZyE7qR0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9md6vsfZyE7qR0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9md6vsfZyE7qR0g6","hints":{}}},"id":"icib9md6vsfZyE7qR0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:48:12Z","lastUpdated":"2025-03-17T17:48:12Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","description":"App SOD Campaign |  Manager Reviewer | User Expression for Realm | entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:48:16-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:48:16-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.realmId==\"guo8emlxtsLOx3Q1H0g7\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00u8emkyb56SK6NNE0g7","selfReviewDisabled":true,"justificationRequired":false,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","summary":"SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","description":"App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with a realm expression and a manager reviewer |tooltip| App separation of duties (SOD) campaign | Manager reviewer | User expression for realm | Entitlements | Show only conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign | Group Reviewer | Entitlements","description":"App SOD Campaign | Group Reviewer | Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T13:56:19-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T13:56:19-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","summary":"SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","description":"App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | Entitlements | Show only conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9n9u1nXwN9PCd0g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9n9u1nXwN9PCd0g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9n9u1nXwN9PCd0g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9n9u1nXwN9PCd0g6","hints":{}}},"id":"icib9n9u1nXwN9PCd0g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T18:43:52Z","lastUpdated":"2025-03-17T18:43:52Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App SOD Campaign | Group Reviewer | User Expression Entitlements","description":"App SOD Campaign | Group Reviewer | User Expression Entitlements","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2025-03-17T14:43:57-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2025-04-16T14:43:57-04:00"},"resourceSettings":{"targetTypes":["APPLICATION"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":true}],"includeEntitlements":true},"principalScopeSettings":{"type":"USERS","userScopeExpression":"user.profile.department == \"Purchasing\" || user.profile.department == \"IT\"","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false,"onlyIncludeUsersWithSODConflicts":true},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"00g8eubpdlXjtVkql0g7","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":false,"reassignmentDisabled":false},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","summary":"SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","description":"App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/SOD campaign to show only conflicts with entitlements, user expression, and a group reviewer |tooltip| App separation of duties (SOD) campaign | Group reviewer | User expression | Entitlements | Show only conflicts"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign with targeted apps through governance label values":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","campaignType":"RESOURCE","description":"App Campaign | Governance Label Values","name":"App Campaign | Governance Label Values","status":"SCHEDULED","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":false,"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Governance campaign with targeted apps through governance label values","summary":"Governance campaign with targeted apps through governance label values","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign with targeted apps through governance label values"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign that targets groups through governance label values":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","campaignType":"RESOURCE","description":"Group Campaign | Governance Label Values","name":"Group Campaign | Governance Label Values","status":"SCHEDULED","scheduleSettings":{"startDate":"2025-03-17T17:56:19.000Z","timeZone":"America/New_York","durationInDays":30,"type":"ONE_OFF"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6vmyH0RQz9f5k0g4"},{"resourceType":"GOVERNANCE_LABEL_VALUE","resourceId":"lblm6v7fmf6cro1KG0g4"}]},"principalScopeSettings":{"type":"USERS","includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":false,"notifyReviewerAtCampaignEnd":false,"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":false,"notifyReviewPeriodEnd":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"NO_ACTION","noResponse":"NO_ACTION"}},"key":"Governance campaign that targets groups through governance label values","summary":"Governance campaign that targets groups through governance label values","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Governance campaign that targets groups through governance label values"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Entitlement Campaign | Governance Label Values","description":"Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"key":"Campaign on an app with entitlements and bundles that are targeted through governance labels","summary":"Campaign on an app with entitlements and bundles that are targeted through governance labels","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on an app with entitlements and bundles that are targeted through governance labels"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Application Entitlement Campaign | Governance Label Values","description":"Application Entitlement Campaign | Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION"],"includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE","includeAllEntitlementsAndBundles":false,"entitlementValueScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}],"entitlementBundleScopeByGovernanceLabelValues":[{"id":"lblm6vmyH0RQz9f5k0g4"},{"id":"lblm6v7fmf6cro1KG0g4"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"key":"Campaign on apps with entitlements and bundles that are all targeted through governance labels","summary":"Campaign on apps with entitlements and bundles that are all targeted through governance labels","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign on apps with entitlements and bundles that are all targeted through governance labels"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying Okta service accounts":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Okta Service Acccount Campaign","description":"Okta Service Acccount Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["OKTA_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"19a2c9b1-78a0-4bf0-be9a-c064dd1eba3f","resourceType":"OKTA_SERVICE_ACCOUNT"}],"includeAllOktaServiceAccounts":false},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"key":"Campaign certifying Okta service accounts","summary":"Campaign certifying Okta service accounts","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying Okta service accounts"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying SaaS app service accounts":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2025-03-17T17:56:15Z","lastUpdated":"2025-03-17T17:56:15Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"App Service Acccount Campaign","description":"App Service Acccount Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APP_SERVICE_ACCOUNT"],"targetResources":[{"resourceId":"0oa8ers0nyoTFEhsc0g7","resourceType":"APPLICATION","includeAllAppServiceAccounts":false,"appServiceAccounts":[{"id":"98318fba-cff5-4394-b67c-2774b3980aec"}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"key":"Campaign certifying SaaS app service accounts","summary":"Campaign certifying SaaS app service accounts","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying SaaS app service accounts"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2024-10-04T13:43:40Z","lastUpdated":"2024-10-04T13:43:40Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Collection Campaign","description":"Collection Campaign","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"col2v7TA5ecDXIvhL0g3","resourceType":"COLLECTION"},{"resourceId":"col2w4CdEIDVHTA4L0g3","resourceType":"COLLECTION"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"key":"Campaign certifying collections","summary":"Campaign certifying collections","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections using governance label values":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icib9mqycMz5bJxx00g6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icib9mqycMz5bJxx00g6","hints":{}}},"id":"icib9mqycMz5bJxx00g6","createdBy":"00u8emkyb56SK6NNE0g7","created":"2024-10-04T13:43:40Z","lastUpdated":"2024-10-04T13:43:40Z","lastUpdatedBy":"00u8emkyb56SK6NNE0g7","name":"Collection Campaign with Governance Label Values","description":"Collection Campaign with Governance Label Values","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T13:43:40.000Z","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["COLLECTION"],"targetResources":[{"resourceId":"lblm6vmyH0RQz9f5k0g4","resourceType":"GOVERNANCE_LABEL_VALUE"},{"resourceId":"lblm6v7fmf6cro1KG0g4","resourceType":"GOVERNANCE_LABEL_VALUE"}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"USER","reviewerId":"00u11afoozJlZKqUj8g6","selfReviewDisabled":true,"justificationRequired":true,"bulkDecisionDisabled":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"status":"SCHEDULED"},"key":"Campaign certifying collections using governance label values","summary":"Campaign certifying collections using governance label values","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying collections using governance label values"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["APPLICATION","GROUP","COLLECTION"],"individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00u12gpFVIth5WbxT0g4","resourceType":"GROUP"},{"resourceId":"00u11knukTc2hYuTC0g5","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","groupIds":["00gyqjxNrZD11n4w40g3","00gyqjxNrZD11n4w40g4"],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","summary":"User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","description":"Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/User centric campaign that includes collection resources |tooltip| Applicable when `campaignType = USER`.\nSpecifies a set of group Ids to review.\nApps, groups, and collections are selected for review.  \n\nIn this example, only users who are in the `principalScopeSettings.groupIds` are selected for review. All access to apps, groups, and collections associated with those users is assessed.\n"},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.":{"value":{"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/launch","hints":{}},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6/end","hints":{}},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icindtwi8SY3MVP1M1d6%22","hints":{}},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icindtwi8SY3MVP1M1d6","hints":{}}},"id":"icindtwi8SY3MVP1M1d6","createdBy":"00u4oll01llSoXHEw1d7","created":"2024-10-04T13:43:35Z","lastUpdated":"2024-10-04T13:43:35Z","lastUpdatedBy":"00u4oll01llSoXHEw1d7","name":"Group Campaign | Justification Required For All","description":"Group Campaign | Justification Required For All","campaignType":"RESOURCE","scheduleSettings":{"type":"ONE_OFF","startDate":"2024-10-04T09:43:40-04:00","durationInDays":30,"timeZone":"America/New_York","endDate":"2024-11-03T08:43:40-05:00"},"resourceSettings":{"targetTypes":["GROUP"],"targetResources":[{"resourceId":"00gg2gzn7m1Aw2zAs1d7","resourceType":"GROUP","includeAllEntitlementsAndBundles":false}]},"principalScopeSettings":{"type":"USERS","excludedUserIds":[],"userIds":[],"groupIds":[],"includeOnlyActiveUsers":false},"reviewerSettings":{"type":"USER","reviewerId":"00u3tm6uw9Cx4Sn8H1d7","selfReviewDisabled":true,"justificationRequired":true,"justificationRequirement":"REQUIRED_FOR_ALL","bulkDecisionDisabled":true},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"remindersReviewerBeforeCampaignCloseInSecs":[86400],"notifyReviewerWhenOverdue":false,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"status":"SCHEDULED"},"key":"Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.","summary":"Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.","description":"The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign with justification requirement |tooltip| The response from a flow that creates a resource campaign with a justification requirement set to REQUIRED_FOR_ALL."},"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of AI agent connections","description":"Review access of certain AI agents to all their connected resources.","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"targetTypes":["AI_AGENT_CONNECTION"],"individuallyAssignedAppsOnly":false,"individuallyAssignedGroupsOnly":false,"excludedResources":[]},"principalScopeSettings":{"type":"AI_AGENTS","aiAgentIds":["wlpx9jQ16k9V8IFEL0g3","wlpx8kR27j0U7HGDM1h4"],"excludedUserIds":[]},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR"},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"DENY"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.","summary":"Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.","description":"This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/201/content/application~1json/examples/Campaign certifying AI agents' connected resources |tooltip| This campaign only certifies AI agents that are in the `principalScopeSettings.aiAgentIds` list."},"paths/~1governance~1api~1v1~1campaigns/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1campaigns/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1campaigns/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign":{"value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=2&filter%3Dname%20eq%20%22Sales%20Review%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dname%20eq%20%22Sales%20Review%22"}}},"key":"List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign","summary":"List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign","description":"The list of campaigns which is filtered by specific name of the campaign","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by name. |tooltip| The list of campaigns which is filtered by specific name of the campaign"},"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state":{"value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"HR Review","description":"Review access of all HR team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=2&filter%3Dstatus%20eq%20%22COMPLETED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22"}}},"key":"List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state","summary":"List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state","description":"The list of campaigns that are all in scheduled state","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by status. |tooltip| The list of campaigns that are all in scheduled state"},"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state.":{"value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"key":"List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state.","summary":"List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state.","description":"The list of campaigns that are all in Completed and Scheduled state.","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. |tooltip| The list of campaigns that are all in Completed and Scheduled state."},"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.":{"value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}},{"id":"icibblYhjKVKNxdcs0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"COMPLETED","recurringCampaignId":"icidlVDNMuEKpwRZc0g1","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"icidlVDNMuEKpwRZc0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icidlVDNMuEKpwRZc0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"key":"List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","summary":"List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","description":"The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include recurring campaigns too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status."},"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.":{"value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}},{"id":"icibblYhjKVKNxdcs0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"GROUP","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"COMPLETED","recurringCampaignId":"icidlVDNMuEKpwRZc0g1","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"icidlVDNMuEKpwRZc0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"RESOURCE_OWNER","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icidlVDNMuEKpwRZc0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"}}},{"id":"ici8t2ROlCM5y664Q0g2","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"MULTI_LEVEL","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici8t2ROlCM5y664Q0g2%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"key":"List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","summary":"List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","description":"The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by multiple statuses. The results include campaigns with reviewer group and with group owners too |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status."},"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.":{"value":{"data":[{"id":"ici2b0ozhrs1S9sVf0g4","created":"2022-04-20T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-04-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","status":"COMPLETED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},{"id":"ici2b0ozhrs1S9sVG9g0","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Sales Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-07-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVG9g0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVG9g0"}}},{"id":"ici2b0fkdhs1S9sVY0g5","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"USER","startDate":"2022-06-20T00:00:01.001Z'","endDate":"2022-07-20T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0fkdhs1S9sVY0g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"}}},{"id":"icibblYhjKVKNxdcs0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"ONE_OFF","reviewerType":"GROUP","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2023-06-23T00:00:01.001Z'","status":"COMPLETED","recurringCampaignId":"icidlVDNMuEKpwRZc0g1","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"icidlVDNMuEKpwRZc0g1","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"RESOURCE_OWNER","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icidlVDNMuEKpwRZc0g1/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0fkdhs1S9sVY0g5"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icibblYhjKVKNxdcs0g1"}}},{"id":"ici8t2ROlCM5y664Q0g2","created":"2019-05-10T14:15:22Z","createdBy":"59473jfjdJGdsfds354","lastUpdated":"2019-05-14T14:15:22Z","lastUpdatedBy":"59473jfjdJGdsfds354","name":"Payroll Department Review","description":"Review access of all sales team members to a specific app","scheduleType":"RECURRING","reviewerType":"MULTI_LEVEL","startDate":"2023-06-01T00:00:01.001Z'","endDate":"2022-07-30T00:00:01.001Z'","status":"SCHEDULED","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icibblYhjKVKNxdcs0g1%22"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici8t2ROlCM5y664Q0g2"}}}],"_links":{"next":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?after=3&filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns?filter%3Dstatus%20eq%20%22COMPLETED%22%20or%20status%20eq%20%22SCHEDULED%22"}}},"key":"List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","summary":"List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","description":"The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status.","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/200/content/application~1json/examples/List of campaigns filtered by campaign type. The results are for user campaigns. |tooltip| The list of campaigns that are all in Completed and Scheduled state. It also lists any recurring campaign in `SCHEDULED` status and any child campaigns in \"COMPLETED\" status."},"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidFilter":{"value":{"errorCode":"E0000053","errorSummary":"Invalid SCIM filter","errorLink":"E0000053","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `filter` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/filter","domain":"governance"}]},"key":"InvalidFilter","summary":"InvalidFilter","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidFilter"},"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidAfter":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `after` parameter isn't valid. Use links in response bodies or headers as the source of truth for paginated requests that contain an `after` parameter.","reason":"INVALID_AFTER_PARAMETER","locationType":"query","location":"/query/after","domain":"governance"}]},"key":"InvalidAfter","summary":"InvalidAfter","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/InvalidAfter"},"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"key":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","summary":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","description":"Invalid `orderBy` parameter error response","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response"},"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1campaigns/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1campaigns/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1campaigns/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"SCHEDULED","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state","summary":"Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state","description":"Get the campaign by Id that is in scheduled state","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in scheduled state. |tooltip| Get the campaign by Id that is in scheduled state"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"LAUNCHING","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state","summary":"Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state","description":"Get the campaign by Id that is in launching state","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in launching state. |tooltip| Get the campaign by Id that is in launching state"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"ERROR","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-05-31T17:00:01.001-07:00","endDate":"2022-06-29T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.","summary":"Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state.","description":"Get the campaign by Id that is in error state.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get campaign by id that is in error state. |tooltip| Get the campaign by Id that is in error state."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","status":"SCHEDULED","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"RECURRING","startDate":"2023-06-01T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles","recurrence":{"interval":"P1M","repeatOnType":"SAME_WEEKDAY_AS_START_DATE"}},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.","summary":"Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.","description":"Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get recurring campaign details in scheduled state. |tooltip| Returns recurring campaign details. If the campaign is still in scheduled status, then expect to get recurring campaign schedule."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.":{"value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"USER","reviewerId":"00ub0oNGTSWTBKOLGLNR","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"recurringCampaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"key":"Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.","summary":"Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.","description":"Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the launched recurring campaign instance. |tooltip| Returns launched recurring campaign instance. Consider this campaign as a child of parent recurring campaign. This campaign instance is either launched as per schedule or manually."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer":{"value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"RESOURCE_OWNER","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"key":"Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer","summary":"Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer","description":"Returns a campaign containing reviewers as owners of the groups under reviewer","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with group owners as reviewers |tooltip| Returns a campaign containing reviewers as owners of the groups under reviewer"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.":{"value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"GROUP","reviewerGroupId":"irgw7zU9vHVj1ldKx0g2","fallBackReviewerId":"00u12gpFVIth5WbxT0g4","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"key":"Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.","summary":"Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.","description":"Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign with reviewer group |tooltip| Returns a campaign having reviewers from a group. All the members of the group will be reviewers of any reviews created from this campaign."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.":{"value":{"id":"ici2cccchrs1S9sVf0g4","status":"ACTIVE","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific app","scheduleSettings":{"type":"ONE_OFF","startDate":"2023-06-01T17:00:01.001-07:00","endDate":"2023-06-22T17:00:01.001-07:00","durationInDays":21,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","targetResources":[{"resourceId":"00gyqjxNrZD11n4w40g3"},{"resourceId":"00ub0oNGTSWTBKOLGLNR"}]},"principalScopeSettings":{"type":"USERS","userScope":{"userScopeExpression":"user.isMemberOf({'group.profile.name': 'TestGroup'})","excludedUserIds":["00ub0oNGTSWTBKOLGLNR"]}},"reviewerSettings":{"type":"MULTI_LEVEL","reviewerLevels":[{"reviewerGroupId":"00g10ukkkcE7g2wvm0g5","fallBackReviewerId":"00u11knwgQvTQvmWA0g5","type":"GROUP","startReview":{"onDay":0}},{"reviewerId":"00u11knsq97GGflac0g5","type":"USER","startReview":{"onDay":11,"when":"LOWER_LEVEL_APPROVES"},"selfReviewDisabled":false}]},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"notificationSettings":{"notifyReviewerWhenReviewAssigned":true,"notifyReviewerAtCampaignEnd":true,"notifyReviewerWhenOverdue":true,"notifyReviewerDuringMidpointOfReview":true,"notifyReviewPeriodEnd":true},"recurringCampaignId":"ici2b0ozhrs1S9sVf0g4","_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4/end"},"campaignDetails":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22ici2cccchrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2cccchrs1S9sVf0g4"}}},"key":"Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.","summary":"Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.","description":"Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Get the campaign of multi level |tooltip| Returns a campaign having level 1 reviewer being a group and level 2 being a user. Reviews will move from level 1 to level 2 to get the final decision."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to all their apps and groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"APPLICATION_AND_GROUP","individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","summary":"Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","description":"The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with user centric and apps and groups as resources |tooltip| The set of properties to pass when creating a user centric campaign with apps and groups as resources for a list of users."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"GROUP","individuallyAssignedAppsOnly":true,"individuallyAssignedGroupsOnly":false,"excludedResources":[{"resourceId":"00g1rv27u2TF9nhTw0g4","resourceType":"GROUP"},{"resourceId":"00g1rv4XS9W3Kpdqr0g4","resourceType":"GROUP"},{"resourceId":"0oa15kjDgk1EubTwo0g4","resourceType":"APPLICATION"},{"resourceId":"0oa15kacS7yNOcBoU0g4","resourceType":"APPLICATION"}]},"principalScopeSettings":{"type":"USERS","userIds":["00u124pT7w9P4kgMe0g4","00u124ujCMdB3fiR10g4","00u12548m6WG7HwkB0g4"],"groupIds":[],"excludedUserIds":[]},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","summary":"Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign user centric with excluded users |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).":{"value":{"id":"ici2b0ozhrs1S9sVf0g4","name":"Monthly access review of sales team","description":"Review access of all sales team members to a specific users and their groups","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","campaignType":"USER","status":"SCHEDULED","scheduleSettings":{"type":"ONE_OFF","startDate":"2022-06-30T17:00:01.001-07:00","durationInDays":30,"timeZone":"America/Los_Angeles"},"resourceSettings":{"type":"APPLICATION","includeEntitlements":true,"onlyIncludeOutOfPolicyEntitlements":false,"targetResources":[{"resourceId":"ent33pQYVKjQdY92H0g3","resourceType":"APPLICATION","includeAllEntitlementsAndBundles":false,"entitlementBundles":[{"id":"00gyqjxNrZD11n4w40g3"}],"entitlements":[{"id":"00ub0oNGTSWTBKOLGLNR","includeAllValues":false,"values":[{"id":"entfxqCAJWWGELFTYAAA"},{"id":"00u12gpFVIth5WbxT0g4"}]}]}]},"principalScopeSettings":{"type":"USERS"},"reviewerSettings":{"type":"REVIEWER_EXPRESSION","reviewerScopeExpression":"user.profile.managerId","fallBackReviewerId":"00utewuyetytiuwe","selfReviewDisabled":false},"remediationSettings":{"accessApproved":"NO_ACTION","accessRevoked":"DENY","noResponse":"NO_ACTION"},"_links":{"launchCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/launch"},"endCampaign":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4/end"},"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%22icieb2db568c7c3007d0%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/ici2b0ozhrs1S9sVf0g4"}}},"key":"Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","summary":"Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","description":"The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups).","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/200/content/application~1json/examples/Campaign with ramp entitlements enabled |tooltip| The set of properties to pass when creating a user centric campaign with excluded resources (apps and groups)."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/409/content/application~1json/example":{"value":{"errorCode":"E0000170","errorSummary":"You can't update a recurring campaign.","errorLink":"E0000170","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/409/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a recurring campaign":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: Campaign","errorLink":"E0000195","errorId":"oaeNrRUPIDuSLGGLWAZ9FXqfA","errorCauses":[{"errorSummary":"Campaign must be scheduled before it can be started"}]},"key":"When launching a recurring campaign","summary":"When launching a recurring campaign","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a recurring campaign"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a launched campaign":{"value":{"errorCode":"E0000195","errorSummary":"Api validation failed due to conflict: Campaign","errorLink":"E0000195","errorId":"oaeNrRUPIDuSLGGLWAZ9FXqfA","errorCauses":[{"errorSummary":"Campaign must be scheduled before it can be started"}]},"key":"When launching a launched campaign","summary":"When launching a launched campaign","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/409/content/application~1json/examples/When launching a launched campaign"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1launch/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody/content/application~1json/examples/createCampaignForGroupAccess":{"value":{"skipRemediation":false},"key":"createCampaignForGroupAccess","summary":"createCampaignForGroupAccess","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/requestBody/content/application~1json/examples/createCampaignForGroupAccess"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/409/content/application~1json/example":{"value":{"errorCode":"E0000170","errorSummary":"An inactive campaign may not be ended.","errorLink":"E0000170","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/409/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1end/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22icitdyhndQ6qstyvR8g5%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DcampaignId%20eq%20%22icitdyhndQ6qstyvR8g5%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after%3D1"}}},"key":"List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign.","summary":"List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign.","description":"The list of reviews that belong to that campaign.","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by campaignId |tooltip| The list of reviews that belong to that campaign."},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3Ddecision%20eq%20%22UNREVIEWED%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3Ddecision%20eq%20%22UNREVIEWED%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3Ddecision%20eq%20%22UNREVIEWED%22"}}},"key":"List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`.","summary":"List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`.","description":"The list of reviews that are filter by specific `decision`.","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by decision made |tooltip| The list of reviews that are filter by specific `decision`."},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"REVOKE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DprincipalId%20eq%20%2200u28w6vzKKultXP98g5%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DprincipalId%20eq%20%2200u28w6vzKKultXP98g5%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DprincipalId%20eq%20%2200u28w6vzKKultXP98g5%22"}}},"key":"List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)","summary":"List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)","description":"The list of access reviews for a specific user (the principal)","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by the principal ID |tooltip| The list of access reviews for a specific user (the principal)"},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by resource ID":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DresourceId%20eq%20%2200gco5q3vQ20oPncs8g5%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DresourceId%20eq%20%2200gco5q3vQ20oPncs8g5%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DresourceId%20eq%20%2200gco5q3vQ20oPncs8g5%22"}}},"key":"List of reviews filtered by resource ID","summary":"List of reviews filtered by resource ID","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by resource ID"},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"NONE","reviewerType":"USER","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerId%20eq%20%2200u5v5viPvg84h0W68g4%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerId%20eq%20%2200u5v5viPvg84h0W68g4%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerId%20eq%20%2200u5v5viPvg84h0W68g4%22"}}},"key":"List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer.","summary":"List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer.","description":"The list of reviews that are assigned to a specific reviewer.","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewer ID |tooltip| The list of reviews that are assigned to a specific reviewer."},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"entitlementBundle":{"id":"ebnb0oNGTSWTBKOLGLNR","name":"Entitlement bundle Name"},"decision":"APPROVE","remediationStatus":"NONE","reviewerGroupProfile":{"name":"Dev ops admins","groupId":"00gw7zU9vHVj1ldKx0g2","groupType":"GROUP"},"reviewerType":"GROUP","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerType%20eq%20%22GROUP%22"}}},"key":"List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type.","summary":"List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type.","description":"The list of reviews that are mapped to specific reviewer type.","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerType |tooltip| The list of reviews that are mapped to specific reviewer type."},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"RESOURCE_OWNER","reviewerGroupProfile":{"name":"Dev ops owners","groupId":"00gco5q3vQ20oPncs8g5","groupType":"RESOURCE_OWNER"},"currentReviewerLevel":"FIRST","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerType%20eq%20%22GROUP%22"}}},"key":"List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.","summary":"List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.","description":"The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign.","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by reviewerLevel |tooltip| The list of reviews whose `currentReviewerLevel` maps the filter criteria. In this example, since the the `currentReviewerLevel = FIRST`, the properties `reviewerGroupProfile`, `reviewerType` are level 1 details defined in the campaign."},"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"entitlementValue":{"id":"entb0oNGTSWTBKOLGLNR","name":"Admin access","externalValue":"admin","entitlement":{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role"}},"decision":"APPROVE","remediationStatus":"NONE","reviewerGroupProfile":{"name":"Dev ops admins","groupId":"00gw7zU9vHVj1ldKx0g2","groupType":"GROUP"},"reviewerType":"GROUP","id":"icrtg6mwccZTRc6Ub8g5","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter%3DreviewerType%20eq%20%22GROUP%22"},"next":{"href":"https://myorg.okta.com/governance/api/v1/reviews?after=1&filter%3DreviewerType%20eq%20%22GROUP%22"}}},"key":"List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID","summary":"List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID","description":"The list of reviews that are mapped to a specific entitlement value ID","id":"paths/~1governance~1api~1v1~1reviews/get/responses/200/content/application~1json/examples/List of reviews filtered by entitlement value ID |tooltip| The list of reviews that are mapped to a specific entitlement value ID"},"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidFilter":{"value":{"errorCode":"E0000053","errorSummary":"Invalid SCIM filter","errorLink":"E0000053","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `filter` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/filter","domain":"governance"}]},"key":"InvalidFilter","summary":"InvalidFilter","id":"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidFilter"},"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidAfter":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `after` parameter isn't valid. Use links in response bodies or headers as the source of truth for paginated requests that contain an `after` parameter.","reason":"INVALID_AFTER_PARAMETER","locationType":"query","location":"/query/after","domain":"governance"}]},"key":"InvalidAfter","summary":"InvalidAfter","id":"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/InvalidAfter"},"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"key":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","summary":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","description":"Invalid `orderBy` parameter error response","id":"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response"},"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1reviews/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1reviews/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1reviews/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1reviews/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1reviews/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign success":{"value":{"reviewerId":"00u31c7qMRUfrhdew0g4","reviewIds":["icrhdk4Lwhd2bBRQe0g2","icrhew4DFTxygUUgE0g2","icrhfvRCfGCHk3y2h0g2"],"note":"John Smith is on leave for this month. His manager Tim will be the reviewer instead."},"key":"Reassign success","summary":"Reassign success","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign success"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned":{"value":{"reviewerId":"00u31c7qMRUfrhdew0g4","reviewIds":["icrhdk4Lwhd2bBRQe0g2","icrhew4DFTxygUUgE0g2","icrhfvRCfGCHk3y2h0g2"],"reviewerLevel":"FIRST","note":"John Smith is on leave for this month. His manager Tim will be the reviewer instead."},"key":"Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned","summary":"Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned","description":"Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/requestBody/content/application~1json/examples/Reassign reviews of multi level campaign by specifying the reviewer level |tooltip| Reassign reviews of multi level campaign. One can reassign by specifying the reviewer level at which reviews should be reassigned"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u2iudyie873","email":"tal.gupta@example.com.com","firstName":"Tal","lastName":"Gupta","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhew4DFTxygUUgE0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhew4DFTxygUUgE0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00847dfjhgd98","email":"juan.garcia@example.com","firstName":"Juan","lastName":"Garcia","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhfvRCfGCHk3y2h0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhfvRCfGCHk3y2h0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/61eb2db568c7c300079fefd0/reviews/reassign"}}},"key":"List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned.","summary":"List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned.","description":"The list of reviews that are reassigned.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews after reassigning to a new reviewer |tooltip| The list of reviews that are reassigned."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u2iudyie873","email":"tal.gupta@example.com","firstName":"Tal","lastName":"Gupta","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhew4DFTxygUUgE0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhew4DFTxygUUgE0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00847dfjhgd98","email":"juan.garcia@example.com","firstName":"Juan","lastName":"Garcia","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhfvRCfGCHk3y2h0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhfvRCfGCHk3y2h0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/61eb2db568c7c300079fefd0/reviews/reassign"}}},"key":"List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","summary":"List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","description":"The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group got reassigned |tooltip| The list of reviews that were originally assigned to a reviewer group. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","currentReviewerLevel":"FIRST","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u2iudyie873","email":"juan.garcia@example.com","firstName":"Juan","lastName":"Garcia","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","currentReviewerLevel":"FIRST","id":"icrhew4DFTxygUUgE0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhew4DFTxygUUgE0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00847dfjhgd98","email":"tal.gupta@example.com","firstName":"Tal","lastName":"Gupta","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","currentReviewerLevel":"FIRST","id":"icrhfvRCfGCHk3y2h0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhfvRCfGCHk3y2h0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%ici2b0ozhrs1S9sVf0g4%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/61eb2db568c7c300079fefd0/reviews/reassign"}}},"key":"List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","summary":"List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","description":"The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/List of reviews that were originally assigned to reviewer group at level 1 |tooltip| The list of reviews that were originally assigned to a reviewer group at `reviewerLevel = ONE`. After reassignment, they are directly assigned to a specific reviewer and `reviewerType` is changed to `USER`."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.":{"value":{"data":[{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u31c7qMRUfrhdew0g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"UNREVIEWED","remediationStatus":"NONE","reviewerType":"USER","id":"icrhdk4Lwhd2bBRQe0g2","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrhdk4Lwhd2bBRQe0g2"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}}],"_links":{"reviews":{"href":"https://myorg.okta.com/governance/api/v1/reviews?filter=campaignId%20eq%20%icitdyhndQ6qstyvR8g5%22"},"self":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"key":"Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.","summary":"Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.","description":"For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/409/content/application~1json/example":{"value":{"errorCode":"E0000174","errorSummary":"When the review(s) is/are already reassigned to intended reviewer.","errorLink":"E0000174","errorId":"oaeWCGz73hpRCG75VHP6-YYEw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/409/content/application~1json/example"},"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1campaigns~1{campaignId}~1reviews~1reassign/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details |tooltip| Success response to get a review details.":{"value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"SUCCESS","note":{"id":"389dhie83","note":"reason for approval"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"USER","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"key":"Success response to get a review details |tooltip| Success response to get a review details.","summary":"Success response to get a review details |tooltip| Success response to get a review details.","description":"Success response to get a review details.","id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details |tooltip| Success response to get a review details."},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile":{"value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"decision":"APPROVE","remediationStatus":"SUCCESS","note":{"id":"389dhie83","note":"reason for approval"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"GROUP","reviewerGroupProfile":{"name":"Dev-Ops Admins","groupId":"00g12gxEULnaMZobr0g4","groupType":"GROUP"},"created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"key":"Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile","summary":"Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile","description":"Success response to get a review details with reviewer group profile","id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Success response to get a review details with reviewer group profile |tooltip| Success response to get a review details with reviewer group profile"},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.":{"value":{"campaignId":"icitdyhndQ6qstyvR8g5","resourceId":"00gco5q3vQ20oPncs8g5","decided":"2019-08-24T14:15:22Z","principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"},"reviewerProfile":{"id":"00u5v5viPvg84h0W68g4","email":"admin@admin.com","firstName":"admin","lastName":"admin","status":"ACTIVE"},"entitlementValue":{"id":"entb0oNGTSWTBKOLGLNR","name":"Admin access","externalValue":"admin","entitlement":{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role"}},"decision":"REVOKE","remediationStatus":"SUCCESS","currentReviewerLevel":"SECOND","note":{"id":"389dhie83","note":"reason for revocation"},"id":"icrtg6mwccZTRc6Ub8g5","reviewerType":"USER","allReviewerLevels":[{"id":"rir77bgs1VB5d45Ot0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"FIRST","decision":"APPROVE","reviewerProfile":{"id":"00u11gerKM8KRGutA0g5","email":"reviewer1@reviewer.com","firstName":"reviewer1","lastName":"reviewer1","status":"ACTIVE"},"reviewerType":"GROUP","reviewerGroupResourceId":"00g141t8uX0rYaIpS0g4","reviewerGroupProfile":{"groupId":"00g141t8uX0rYaIpS0g4","globalName":"Dev-Ops Amins","name":"Dev-Ops Admins","groupType":"GROUP"}},{"id":"rir77bhvegddkTFIc0g4","createdBy":"00uyi3k2qJ4nfR8rb0g4","created":"2019-08-24T14:15:22Z","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00uyi3k2qJ4nfR8rb0g4","reviewerLevel":"SECOND","decision":"REVOKE","reviewerProfile":{"id":"00u11get1k7R75JrS0g5","email":"reviewer2@reviewer.com","firstName":"reviewer2","lastName":"reviewer2","status":"ACTIVE"},"reviewerType":"USER"}],"created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/reviews/icrtg6mwccZTRc6Ub8g5"},"reassignReview":{"href":"https://myorg.okta.com/governance/api/v1/campaigns/icitdyhndQ6qstyvR8g5/reviews/reassign"}}},"key":"Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.","summary":"Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.","description":"For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level.","id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/200/content/application~1json/examples/Multi level campaign - success response to get a review details with details at all reviewer levels |tooltip| For a multi level campaign, a success response to get a review details. It also includes detailed information of decisions, reviewers involved in making those decisions at each reviewer level."},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1reviews~1{reviewId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/post/requestBody/content/application~1json/examples/New entitlement |tooltip| Request body for adding an entitlement":{"value":{"name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"dataType":"string","values":[{"name":"value1","description":"description for value1","externalValue":"value_1"},{"name":"value2","description":"description for value2","externalValue":"value_2"}]},"key":"New entitlement |tooltip| Request body for adding an entitlement","summary":"New entitlement |tooltip| Request body for adding an entitlement","description":"Request body for adding an entitlement","id":"paths/~1governance~1api~1v1~1entitlements/post/requestBody/content/application~1json/examples/New entitlement |tooltip| Request body for adding an entitlement"},"paths/~1governance~1api~1v1~1entitlements/post/responses/201/content/application~1json/examples/Create entitlement example |tooltip| Response for a successful entitlement creation":{"value":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"required":false,"dataType":"string","values":[{"id":"ent148fuJDGTsvYjP0g4","name":"value1","description":"description for value1","externalValue":"value_1","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148fuJDGT"},{"id":"ent148gF8aZoRfFsh0g4","name":"value2","description":"description for value2","externalValue":"value_2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148gF8aZoRfFsh0g4"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6/values"}},"metadata":{"total":2}},"key":"Create entitlement example |tooltip| Response for a successful entitlement creation","summary":"Create entitlement example |tooltip| Response for a successful entitlement creation","description":"Response for a successful entitlement creation","id":"paths/~1governance~1api~1v1~1entitlements/post/responses/201/content/application~1json/examples/Create entitlement example |tooltip| Response for a successful entitlement creation"},"paths/~1governance~1api~1v1~1entitlements/post/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /requiredField/0 must cannot be null","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"entitlements","errorSummary":"must have required field","location":"/requiredField/","locationType":"body","reason":"REQUIRED_PROPERTY_MISSING"}]},"key":"When required field is missing |tooltip| When the requiredField is missing","summary":"When required field is missing |tooltip| When the requiredField is missing","description":"When the requiredField is missing","id":"paths/~1governance~1api~1v1~1entitlements/post/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"},"paths/~1governance~1api~1v1~1entitlements/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/get/responses/200/content/application~1json/examples/List entitlements for a specific resource |tooltip| A list of entitlements":{"value":{"data":[{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":true,"required":false,"dataType":"string","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values"}}},{"id":"espfxqCAJWWGEGUUFASJ","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGEGUUFASJ"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGEGUUFASJ/values"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements?limit=20"}},"metadata":{"total":2}},"key":"List entitlements for a specific resource |tooltip| A list of entitlements","summary":"List entitlements for a specific resource |tooltip| A list of entitlements","description":"A list of entitlements","id":"paths/~1governance~1api~1v1~1entitlements/get/responses/200/content/application~1json/examples/List entitlements for a specific resource |tooltip| A list of entitlements"},"paths/~1governance~1api~1v1~1entitlements/get/responses/400/content/application~1json/examples/When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist":{"value":{"errorCode":"E0000029","errorSummary":"Invalid externalId request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"0oab2db568c7c300079fefd0 not found","reason":"IDENTIFIER_NOT_FOUND","locationType":"query","location":"/target.externalId","domain":"governance"}]},"key":"When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist","summary":"When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist","description":"When a request contains target.externalId query parameter with id that does not exist","id":"paths/~1governance~1api~1v1~1entitlements/get/responses/400/content/application~1json/examples/When target.externalId not found |tooltip| When a request contains target.externalId query parameter with id that does not exist"},"paths/~1governance~1api~1v1~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/200/content/application~1json/examples/Retrieve an entitlement response |tooltip| Retrieve an entitlement response":{"value":{"id":"espfxqCAJWWGELFTYASJ","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":true,"required":false,"dataType":"string","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ"},"values":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values"}},"metadata":{"total":1}},"key":"Retrieve an entitlement response |tooltip| Retrieve an entitlement response","summary":"Retrieve an entitlement response |tooltip| Retrieve an entitlement response","description":"Retrieve an entitlement response","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/200/content/application~1json/examples/Retrieve an entitlement response |tooltip| Retrieve an entitlement response"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody/content/application~1json/examples/Update an entitlement |tooltip| Request body for updating an entitlement":{"value":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement","externalValue":"license_entitlement","description":"Entitlement description","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"dataType":"string","values":[{"id":"ent148gF8aZoRfFsh0g4","name":"value1","description":"description for value1","externalValue":"value_1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148gF8aZoRfFsh0g4"},{"id":"entotuwr1z1efm5RA1d6","name":"value2","description":"new value for entitlement","externalValue":"value_2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entotuwr1z1efm5RA1d6"}]},"key":"Update an entitlement |tooltip| Request body for updating an entitlement","summary":"Update an entitlement |tooltip| Request body for updating an entitlement","description":"Request body for updating an entitlement","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/requestBody/content/application~1json/examples/Update an entitlement |tooltip| Request body for updating an entitlement"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update":{"value":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"dataType":"string","required":false,"values":[{"id":"ent148gF8aZoRfFsh0g4","name":"Updated value1","description":"description for value1","externalValue":"value_1","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148gF8aZoRfFsh0g4"},{"id":"ent148fuJDGTsvYjP0g4","name":"Updated value2","description":"description for value2","externalValue":"value_2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148fuJDGTsvYjP0g4"}],"_links":{"self":{"href":"https://myorg.okta.com//governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6"},"values":{"href":"https://myorg.okta.com//governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6/values"}},"metadata":{"total":2}},"key":"Update entitlement example |tooltip| Response for successful entitlement update","summary":"Update entitlement example |tooltip| Response for successful entitlement update","description":"Response for successful entitlement update","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /requiredField/0 must cannot be null","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"entitlements","errorSummary":"must have required field","location":"/requiredField/","locationType":"body","reason":"REQUIRED_PROPERTY_MISSING"}]},"key":"When required field is missing |tooltip| When the requiredField is missing","summary":"When required field is missing |tooltip| When the requiredField is missing","description":"When the requiredField is missing","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update entitlement |tooltip| Request body for updating entitlement":{"value":[{"op":"ADD","path":"/values/-","value":{"name":"value1","description":"description for value1","externalValue":"value_1"},"refType":"ENTITLEMENT-VALUE"},{"op":"REMOVE","path":"/values/ent148gF8aZoRfFsh0g4","refType":"ENTITLEMENT-VALUE"},{"op":"REPLACE","path":"/values/ent148gF8aZoRfFsh0g4","value":{"name":"value1","description":"replace description for value1"},"refType":"ENTITLEMENT-VALUE"},{"op":"ADD","path":"/description","value":"add description for entitlement","refType":"ENTITLEMENT"},{"op":"REMOVE","path":"/description","refType":"ENTITLEMENT"},{"op":"REPLACE","path":"/description","value":"replace description for entitlement","refType":"ENTITLEMENT"},{"op":"REPLACE","path":"/name","value":"replace name for entitlement","refType":"ENTITLEMENT"}],"key":"Update entitlement |tooltip| Request body for updating entitlement","summary":"Update entitlement |tooltip| Request body for updating entitlement","description":"Request body for updating entitlement","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update entitlement |tooltip| Request body for updating entitlement"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - add entitlement value |tooltip| Request body for adding entitlement value":{"value":[{"op":"ADD","path":"/values/-","value":{"name":"value1","description":"description for value1","externalValue":"value_1"},"refType":"ENTITLEMENT-VALUE"}],"key":"Update - add entitlement value |tooltip| Request body for adding entitlement value","summary":"Update - add entitlement value |tooltip| Request body for adding entitlement value","description":"Request body for adding entitlement value","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - add entitlement value |tooltip| Request body for adding entitlement value"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - remove entitlement value |tooltip| Request body for removing entitlement value":{"value":[{"op":"REMOVE","path":"/values/ent148gF8aZoRfFsh0g4","refType":"ENTITLEMENT-VALUE"}],"key":"Update - remove entitlement value |tooltip| Request body for removing entitlement value","summary":"Update - remove entitlement value |tooltip| Request body for removing entitlement value","description":"Request body for removing entitlement value","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - remove entitlement value |tooltip| Request body for removing entitlement value"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - replace entitlement value |tooltip| Request body for replacing entitlement value":{"value":[{"op":"REPLACE","path":"/values/ent148gF8aZoRfFsh0g4","value":{"name":"value1","description":"replace description for value1"},"refType":"ENTITLEMENT-VALUE"}],"key":"Update - replace entitlement value |tooltip| Request body for replacing entitlement value","summary":"Update - replace entitlement value |tooltip| Request body for replacing entitlement value","description":"Request body for replacing entitlement value","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/requestBody/content/application~1json/examples/Update - replace entitlement value |tooltip| Request body for replacing entitlement value"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update":{"value":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"multiValue":true,"dataType":"string","required":false,"values":[{"id":"ent148gF8aZoRfFsh0g4","name":"Updated value1","description":"description for value1","externalValue":"value_1","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148gF8aZoRfFsh0g4"},{"id":"ent148fuJDGTsvYjP0g4","name":"Updated value2","description":"description for value2","externalValue":"value_2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent148fuJDGTsvYjP0g4"}],"_links":{"self":{"href":"https://myorg.okta.com//governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6"},"values":{"href":"https://myorg.okta.com//governance/api/v1/entitlements/esp2lr1lavoGDYw5U8g6/values"}},"metadata":{"total":2}},"key":"Update entitlement example |tooltip| Response for successful entitlement update","summary":"Update entitlement example |tooltip| Response for successful entitlement update","description":"Response for successful entitlement update","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/200/content/application~1json/examples/Update entitlement example |tooltip| Response for successful entitlement update"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /requiredField/0 must cannot be null","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"entitlements","errorSummary":"must have required field","location":"/requiredField/","locationType":"body","reason":"REQUIRED_PROPERTY_MISSING"}]},"key":"When required field is missing |tooltip| When the requiredField is missing","summary":"When required field is missing |tooltip| When the requiredField is missing","description":"When the requiredField is missing","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/400/content/application~1json/examples/When required field is missing |tooltip| When the requiredField is missing"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values":{"value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","externalValue":"corporate","entitlementId":"esp81PLbVQGWaklZb0g2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"key":"List of values for a specific resource |tooltip| A list of entitlement values","summary":"List of values for a specific resource |tooltip| A list of entitlement values","description":"A list of entitlement values","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID":{"value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","entitlementId":"esp5zFLCIUV7Vibro0g2","externalValue":"{\"name\":\"admin\", \"externalId\":\"75941239-123s-1245-xyz6-562fee27167r\"}","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","entitlementId":"esp81PLbVQGWaklZb0g2","externalValue":"{\"name\":\"corporate\", \"externalId\":\"75941239-123s-1245-xyz6-562fee27167r\"}","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"key":"List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","summary":"List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","description":"A list of entitlement values with an external value ID","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels":{"value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}}]},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","externalValue":"corporate","entitlementId":"esp81PLbVQGWaklZb0g2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"key":"List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels","summary":"List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels","description":"A list of entitlement values with assigned labels","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/200/content/application~1json/examples/Entitlement value data |tooltip| Entitlement value data":{"value":{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},"key":"Entitlement value data |tooltip| Entitlement value data","summary":"Entitlement value data |tooltip| Entitlement value data","description":"Entitlement value data","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/200/content/application~1json/examples/Entitlement value data |tooltip| Entitlement value data"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1{entitlementId}~1values~1{valueId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values":{"value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","externalValue":"corporate","entitlementId":"esp81PLbVQGWaklZb0g2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"key":"List of values for a specific resource |tooltip| A list of entitlement values","summary":"List of values for a specific resource |tooltip| A list of entitlement values","description":"A list of entitlement values","id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource |tooltip| A list of entitlement values"},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID":{"value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","entitlementId":"esp5zFLCIUV7Vibro0g2","externalValue":"{\"name\":\"admin\", \"externalId\":\"75941239-123s-1245-xyz6-562fee27167r\"}","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}}},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","entitlementId":"esp81PLbVQGWaklZb0g2","externalValue":"{\"name\":\"corporate\", \"externalId\":\"75941239-123s-1245-xyz6-562fee27167r\"}","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"key":"List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","summary":"List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID","description":"A list of entitlement values with an external value ID","id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource with an external value ID |tooltip| A list of entitlement values with an external value ID"},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels":{"value":{"data":[{"id":"entfxqCAJWWGELFTYAAA","name":"Admin access","description":"ability to grant an access","externalValue":"admin","entitlementId":"esp5zFLCIUV7Vibro0g2","externalId":"75941239-123s-1245-xyz6-562fee27167r","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp5zFLCIUV7Vibro0g2/values/entfxqCAJWWGELFTYAAA"}},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}}]},{"id":"entfxqCAJWWFTFUUYBBB","name":"Corporate License","description":"Corporate License","externalValue":"corporate","entitlementId":"esp81PLbVQGWaklZb0g2","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWFTFUUYBBB","parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/esp81PLbVQGWaklZb0g2/values/entfxqCAJWWFTFUUYBBB"}},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlements/espfxqCAJWWGELFTYASJ/values?limit=20"}},"metadata":{"total":2}},"key":"List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels","summary":"List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels","description":"A list of entitlement values with assigned labels","id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/200/content/application~1json/examples/List of values for a specific resource including assigned labels |tooltip| A list of entitlement values with assigned labels"},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlements~1values/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value":{"value":{"name":"Salesforce admin bundle","description":"A bundle for full administrative access in salesforce","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}]},"key":"One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value","summary":"One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value","description":"Request body for adding an entitlement bundle with one entitlement, one value","id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, one value |tooltip| Request body for adding an entitlement bundle with one entitlement, one value"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements":{"value":{"name":"Salesforce admin bundle","description":"A bundle for full administrative access in salesforce","target":{"type":"APPLICATION","externalId":"0oafxqCAJWWGELFTYASJ"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]}]},"key":"One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements","summary":"One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements","description":"Request body for adding an entitlement bundle with many entitlements","id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/requestBody/content/application~1json/examples/One entitlement, two entitlement values |tooltip| Request body for adding an entitlement bundle with many entitlements"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value":{"value":{"id":"enbo3j1lwErh6dn701d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYAAA"}}},"key":"Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","summary":"Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","description":"Entitlement Bundle with one entitlement and one value","id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements":{"value":{"id":"enbo3j1lwErh6dn701d6","name":"Salesforce admin bundle","description":"Salesforce profile","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}},"key":"Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","summary":"Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","description":"Entitlement bundle with many entitlements","id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/201/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/400/content/application~1json/examples/entitlementBundleSettingsMissing":{"value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The settings for a entitlement bundle must be specified.","reason":"MISSING_SETTINGS","locationType":"body","location":"settings","domain":"entitlement-bundle"}]},"key":"entitlementBundleSettingsMissing","summary":"entitlementBundleSettingsMissing","description":"When no resources are provided","id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/400/content/application~1json/examples/entitlementBundleSettingsMissing"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter":{"value":{"data":[{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles?limit=20"}},"metadata":{"total":10}},"key":"List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter","summary":"List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter","description":"A list of entitlement bundle with no filter","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with no filter |tooltip| A list of entitlement bundle with no filter"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements":{"value":{"data":[{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"Role","externalValue":"Role","description":"Role entitlement property","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Admin access","externalValue":"admin","description":"provides admin access role"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles?limit=20"}},"metadata":{"total":10}},"key":"List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements","summary":"List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements","description":"A list of entitlement bundles with full entitlements","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/200/content/application~1json/examples/List entitlement bundles response with full entitlements |tooltip| A list of entitlement bundles with full entitlements"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Empty value found for query parameter 'after'","reason":"empty.openapi.validation","locationType":"query","location":"/query/after"}]},"key":"When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)","summary":"When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)","description":"When a request contains after query parameter but it is empty (?after=)","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is empty |tooltip| When a request contains after query parameter but it is empty (?after=)"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"must NOT have fewer than 24 characters","reason":"minLength.openapi.validation","locationType":"query","location":"/query/after"},{"errorSummary":"must match pattern \"^[a-fA-F\\\\d]{24}$\"","reason":"pattern.openapi.validation","locationType":"query","location":"/query/after"},{"errorSummary":"must match format \"entitlement-bundle-id\"","reason":"format.openapi.validation","locationType":"query","location":"/query/after"},{"errorSummary":"format is invalid","reason":"serdes.openapi.validation","locationType":"query","location":"/query/after"}]},"key":"When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)","summary":"When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)","description":"When a request contains after query parameter but it has invalid format (?after=1)","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter is invalid format |tooltip| When a request contains after query parameter but it has invalid format (?after=1)"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request.","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Request type 08ab2db568c7c300079fefd0 not found","reason":"serdes.openapi.validation","locationType":"query","location":"/query/after"}]},"key":"When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist","summary":"When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist","description":"When a request contains after query parameter with request id that does not exist","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/When after parameter value not found |tooltip| When a request contains after query parameter with request id that does not exist"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"key":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","summary":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","description":"Invalid `orderBy` parameter error response","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value":{"value":{"id":"enbo3j1lwErh6dn701d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYAAA"}}},"key":"Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","summary":"Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","description":"Entitlement Bundle with one entitlement and one value","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements":{"value":{"id":"enbo3j1lwErh6dn701d6","name":"Salesforce admin bundle","description":"Salesforce profile","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}},"key":"Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","summary":"Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","description":"Entitlement bundle with many entitlements","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value":{"value":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"Role","externalValue":"Role","description":"Role entitlement property","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Admin access","externalValue":"admin","description":"provides admin access role"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYAAA"}}},"key":"Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value","summary":"Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value","description":"Entitlement Bundle with full entitlement and one entitlement value","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and one entitlement value |tooltip| Entitlement Bundle with full entitlement and one entitlement value"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values":{"value":{"id":"enbo3j1lwErh6dn701d6","name":"Salesforce admin bundle","description":"Salesforce profile","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"License entitlement property","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","externalValue":"A","name":"A Label","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}},"key":"Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values","summary":"Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values","description":"Entitlement bundle with full entitlement and many entitlements values","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/200/content/application~1json/examples/Entitlement Bundle with full entitlement and many entitlements values |tooltip| Entitlement bundle with full entitlement and many entitlements values"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values":{"value":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3ioilCWXR316t1d6"}]}]},"key":"Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values","summary":"Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values","description":"Entitlement bundle with multiple entitlements values","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update entitlements for a bundle |tooltip| Entitlement bundle with multiple entitlements values"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values":{"value":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle (updated)","description":"Github bundle for administrative access (updated)","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3ioilCWXR316t1d6"}]}]},"key":"Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values","summary":"Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values","description":"Entitlement bundle with multiple entitlement values","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/requestBody/content/application~1json/examples/Update name and description for a bundle |tooltip| Entitlement bundle with multiple entitlement values"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value":{"value":{"id":"enbo3j1lwErh6dn701d6","name":"Github admin bundle","description":"Github bundle for administrative access","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:github:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYAAA"}}},"key":"Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","summary":"Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value","description":"Entitlement Bundle with one entitlement and one value","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with single entitlement |tooltip| Entitlement Bundle with one entitlement and one value"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements":{"value":{"id":"enbo3j1lwErh6dn701d6","name":"Salesforce admin bundle","description":"Salesforce profile","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbo3j1lwErh6dn701d6","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","status":"ACTIVE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbllojq9J9J105DL1d6"}}},"key":"Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","summary":"Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements","description":"Entitlement bundle with many entitlements","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/200/content/application~1json/examples/Entitlement Bundle with multiple entitlement values |tooltip| Entitlement bundle with many entitlements"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleEntitlementsMissing":{"value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The entitlements for a entitlement bundle must be specified.","reason":"MISSING_ENTITLEMENTS","locationType":"body","location":"entitlements","domain":"entitlement-bundle"}]},"key":"entitlementBundleEntitlementsMissing","summary":"entitlementBundleEntitlementsMissing","description":"When no entitlements are provided","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleEntitlementsMissing"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleNameMissing":{"value":{"errorCode":"E0000028","errorSummary":"The request is missing a required parameter.","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The name for a entitlement bundle must be specified.","reason":"MISSING_NAME","locationType":"body","location":"name","domain":"entitlement-bundle"}]},"key":"entitlementBundleNameMissing","summary":"entitlementBundleNameMissing","description":"When no name is provided","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/400/content/application~1json/examples/entitlementBundleNameMissing"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/409/content/application~1json/examples/Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type":{"value":{"errorCode":"E0000169","errorSummary":"Object status conflicts with requested operation.","errorLink":"E0000169","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"A Request type with status DELETED may not be deleted.","reason":"OPERATION_STATUS_CONFLICT","locationType":"method","location":"POST","domain":"entitlement-bundle"}]},"key":"Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type","summary":"Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type","description":"When attempting to delete a deleted Request type","id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/409/content/application~1json/examples/Conflict deleting a deleted Request type |tooltip| When attempting to delete a deleted Request type"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1entitlement-bundles~1{entitlementBundleId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal":{"value":{"grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","actor":"ACCESS_REQUEST","targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"}},"key":"Grant a bundle to a principal","summary":"Grant a bundle to a principal","id":"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal"},"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal, with an expiration date":{"value":{"grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","actor":"ACCESS_REQUEST","targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"},"scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z"}},"key":"Grant a bundle to a principal, with an expiration date","summary":"Grant a bundle to a principal, with an expiration date","id":"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant a bundle to a principal, with an expiration date"},"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant using a policy |tooltip| Grant using a policy":{"value":{"grantType":"POLICY","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"}},"key":"Grant using a policy |tooltip| Grant using a policy","summary":"Grant using a policy |tooltip| Grant using a policy","description":"Grant using a policy","id":"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Grant using a policy |tooltip| Grant using a policy"},"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties":{"value":{"grantType":"CUSTOM","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}]},"key":"Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties","summary":"Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties","description":"Custom grant using entitlements with single and multi value properties","id":"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Custom grant with entitlements |tooltip| Custom grant using entitlements with single and multi value properties"},"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.":{"value":{"grantType":"CUSTOM","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipal":{"externalId":"00ufxqCAJWWGELFTYCCC","type":"OKTA_USER"},"action":"DENY"},"key":"Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.","summary":"Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource.","description":"Revoke all grants for a principal. This will also take away access to the resource.","id":"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Revoke all grants for a principal |tooltip| Revoke all grants for a principal. This will also take away access to the resource."},"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements.":{"value":{"grantType":"ENTITLEMENT","target":{"externalId":"0oa251e7jQHXVgg5r0g4","type":"APPLICATION"},"targetPrincipal":{"externalId":"00um8cshZwJhHgpvV0g4","type":"OKTA_USER"},"entitlements":[{"id":"esp1o5jmfBTZUCzcW0g5","values":[{"id":"ent1o5jo0bHpxiDVJ0g5"}]}]},"key":"Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements.","summary":"Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements.","description":"Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements.","id":"paths/~1governance~1api~1v1~1grants/post/requestBody/content/application~1json/examples/Entitlement grant with values |tooltip| Grant specific entitlement values to a principal. These entitlements are added to any existing granted entitlements."},"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"ACCESS_REQUEST","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbfxqCAJWWGELFTYCCC"},"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Grant a bundle to a principal","summary":"Grant a bundle to a principal","id":"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal"},"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal, with expiration":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z","timeZone":"America/Toronto"},"_links":{"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYCCC"},"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Grant a bundle to a principal, with expiration","summary":"Grant a bundle to a principal, with expiration","id":"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a bundle to a principal, with expiration"},"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"POLICY","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","action":"ALLOW","actor":"NONE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Grant a resource with policy |tooltip| Grant a resource with policy","summary":"Grant a resource with policy |tooltip| Grant a resource with policy","description":"Grant a resource with policy","id":"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy"},"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ent6asdxmkvabcltm3g5"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","summary":"Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","description":"Grant a resource with custom entitlements","id":"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements"},"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Entitlement grant with values":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oa251e7jQHXVgg5r0g4","target":{"externalId":"0oa251e7jQHXVgg5r0g4","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00um8cshZwJhHgpvV0g4","targetPrincipal":{"externalId":"00um8cshZwJhHgpvV0g4","type":"OKTA_USER"},"entitlements":[{"id":"esp1o5jmfBTZUCzcW0g5","values":[{"id":"ent1o5jo0bHpxiDVJ0g5"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Entitlement grant with values","summary":"Entitlement grant with values","id":"paths/~1governance~1api~1v1~1grants/post/responses/201/content/application~1json/examples/Entitlement grant with values"},"paths/~1governance~1api~1v1~1grants/post/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found.":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /entitlementBundleId 61eb2db568c7c300079fefd0 not found","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"governance","errorSummary":"61eb2db568c7c300079fefd0 not found","location":"/entitlementBundleId","locationType":"body","reason":"IDENTIFIER_NOT_FOUND"}]},"key":"When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found.","summary":"When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found.","description":"Bad request response when entitlementBundleId cannot be found.","id":"paths/~1governance~1api~1v1~1grants/post/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."},"paths/~1governance~1api~1v1~1grants/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1grants/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1grants/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.":{"value":{"data":[{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"ACCESS_REQUEST","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"},"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbfxqCAJWWGELFTYCCC"}}},{"id":"0ggb0oNGTSWTBKOJGDS","created":"2022-03-23T11:11:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-03-23T11:11:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"POLICY","action":"ALLOW","actor":"NONE","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOJGDS"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants?filter=\"target.externalId%20eq%20%220oafxqCAJWWGELFTYASJ%22%20AND%20target.type%20eq%20%22APPLICATION%22%20AND%20targetPrincipal.externalId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20AND%20targetPrincipal.type%20eq%20%22OKTA_USER%22\""}}},"key":"Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.","summary":"Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.","description":"A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date.","id":"paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with multiple active grants |tooltip| A principal user can have active `POLICY` grants and `ENTITLEMENT-BUNDLE` grants. This is common when an entitlement policy grants a user an entitlement, and then a user requests access to a specific entitlement bundle at a later date."},"paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements":{"value":{"data":[{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"},{"id":"ent4rg7fu190Eg75a8g6","name":"D label","externalValue":"D","description":"D label description"}]}],"targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants?filter=\"target.externalId%20eq%20%220oafxqCAJWWGELFTYASJ%22%20AND%20target.type%20eq%20%22APPLICATION%22%20AND%20targetPrincipal.externalId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20AND%20targetPrincipal.type%20eq%20%22OKTA_USER%22\""}}},"key":"Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements","summary":"Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements","description":"Grants list for a resource and user with only Custom grant type with full entitlements","id":"paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with only custom grant type |tooltip| Grants list for a resource and user with only Custom grant type with full entitlements"},"paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included":{"value":{"data":[{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","metadata":{"id":"00cfxqCAJWWGELFTYAAA","name":"Some collection name"},"values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"},{"id":"ent4rg7fu190Eg75a8g6","name":"D label","externalValue":"D","description":"D label description"}]}],"targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants?filter=\"target.externalId%20eq%20%220oafxqCAJWWGELFTYASJ%22%20AND%20target.type%20eq%20%22APPLICATION%22%20AND%20targetPrincipal.externalId%20eq%20%2200ub0oNGTSWTBKOLGLNR%22%20AND%20targetPrincipal.type%20eq%20%22OKTA_USER%22\""}}},"key":"Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included","summary":"Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included","description":"Grants list for a resource and user with metadata included","id":"paths/~1governance~1api~1v1~1grants/get/responses/200/content/application~1json/examples/Grants list with metadata included |tooltip| Grants list for a resource and user with metadata included"},"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When no target resource provided in filter |tooltip| When a request contains filter without a target resource":{"value":{"errorCode":"E0000029","errorSummary":"Invalid filter","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Cannot find value found for target resource'","reason":"empty.openapi.validation","locationType":"query","location":"/query/filter"}]},"key":"When no target resource provided in filter |tooltip| When a request contains filter without a target resource","summary":"When no target resource provided in filter |tooltip| When a request contains filter without a target resource","description":"When a request contains filter without a target resource","id":"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When no target resource provided in filter |tooltip| When a request contains filter without a target resource"},"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource":{"value":{"errorCode":"E0000029","errorSummary":"Invalid filter","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Multiple values found for target resource'","reason":"empty.openapi.validation","locationType":"query","location":"/query/filter"}]},"key":"When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource","summary":"When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource","description":"When a request contains filter with multiple target resource","id":"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When multiple target resource provided in filter |tooltip| When a request contains filter with multiple target resource"},"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception.","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Cannot find entitlement with id 08ab2db568c7c300079fefd0","reason":"empty.openapi.validation","locationType":"query","location":"/query/filter"}]},"key":"When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id","summary":"When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id","description":"When a request contains filter with invalid entitlement id or entitlement value id","id":"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/When invalid entitlement id or entitlement value id is provided |tooltip| When a request contains filter with invalid entitlement id or entitlement value id"},"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1grants/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1grants/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1grants/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1grants/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"ACCESS_REQUEST","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","_links":{"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/enbfxqCAJWWGELFTYCCC"},"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Grant a bundle to a principal","summary":"Grant a bundle to a principal","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z","timeZone":"America/Toronto"},"_links":{"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYCCC"},"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Grant a bundle to a principal, with expiration","summary":"Grant a bundle to a principal, with expiration","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"POLICY","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","action":"ALLOW","actor":"NONE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Grant a resource with policy |tooltip| Grant a resource with policy","summary":"Grant a resource with policy |tooltip| Grant a resource with policy","description":"Grant a resource with policy","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Grant a resource with policy |tooltip| Grant a resource with policy"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ent6asdxmkvabcltm3g5"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","summary":"Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","description":"Grant a resource with custom entitlements","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fu190Eg75a8g6","name":"C label","externalValue":"C","description":"C label description"},{"id":"ent4rg7fltWSgrlDT8g6","name":"D label","externalValue":"D","description":"D label description"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements","summary":"Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements","description":"Grant a resource with custom entitlements","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant a resource with full entitlements loaded |tooltip| Grant a resource with custom entitlements"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}],"status":"ACTIVE","metadata":{"collection":{"id":"00cb0oNGTSWTBKOLGLNR","name":"Some Collection"}},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata","summary":"Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata","description":"Grant for a resource with custom entitlements and grant metadata","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/200/content/application~1json/examples/Custom Grant with metadata |tooltip| Grant for a resource with custom entitlements and grant metadata"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody/content/application~1json/examples/Update custom grant entitlements |tooltip| Update custom grant entitlements.":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Update custom grant entitlements |tooltip| Update custom grant entitlements.","summary":"Update custom grant entitlements |tooltip| Update custom grant entitlements.","description":"Update custom grant entitlements.","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/put/requestBody/content/application~1json/examples/Update custom grant entitlements |tooltip| Update custom grant entitlements."},"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"CUSTOM","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ent6asdxmkvabcltm3g5"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"},{"id":"ent4rg7fu190Eg75a8g6"}]}],"status":"ACTIVE","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","summary":"Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements","description":"Grant a resource with custom entitlements","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/200/content/application~1json/examples/Custom Grant with entitlements |tooltip| Grant a resource with custom entitlements"},"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found.":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /entitlementBundleId 61eb2db568c7c300079fefd0 not found","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"governance","errorSummary":"61eb2db568c7c300079fefd0 not found","location":"/entitlementBundleId","locationType":"body","reason":"IDENTIFIER_NOT_FOUND"}]},"key":"When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found.","summary":"When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found.","description":"Bad request response when entitlementBundleId cannot be found.","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/400/content/application~1json/examples/When the entitlement bundle cannot be found |tooltip| Bad request response when entitlementBundleId cannot be found."},"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date |tooltip| Update grant's expiration date.":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z"}},"key":"Update grant's expiration date |tooltip| Update grant's expiration date.","summary":"Update grant's expiration date |tooltip| Update grant's expiration date.","description":"Update grant's expiration date.","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date |tooltip| Update grant's expiration date."},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z","timeZone":"America/Toronto"}},"key":"Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone","summary":"Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone","description":"Update the grant expiry date (in UTC time) and save the user time zone","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/requestBody/content/application~1json/examples/Update grant's expiration date and user timezone |tooltip| Update the grant expiry date (in UTC time) and save the user time zone"},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration":{"value":{"id":"0ggb0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","grantType":"ENTITLEMENT-BUNDLE","entitlementBundleId":"enbfxqCAJWWGELFTYCCC","action":"ALLOW","actor":"API","targetResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","target":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"status":"ACTIVE","scheduleSettings":{"expirationDate":"2022-11-24T14:15:22Z","timeZone":"America/Toronto"},"_links":{"entitlementBundle":{"href":"https://myorg.okta.com/governance/api/v1/entitlement-bundles/0bbfxqCAJWWGELFTYCCC"},"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/0ggb0oNGTSWTBKOLGLNR"}}},"key":"Grant a bundle to a principal, with expiration","summary":"Grant a bundle to a principal, with expiration","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/200/content/application~1json/examples/Grant a bundle to a principal, with expiration"},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/400/content/application~1json/examples/When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found.":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: /grantId 61eb2db568c7c300079fefd0 not found","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"domain":"governance","errorSummary":"61eb2db568c7c300079fefd0 not found","location":"/grantId","locationType":"body","reason":"IDENTIFIER_NOT_FOUND"}]},"key":"When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found.","summary":"When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found.","description":"Bad request response when grantId cannot be found.","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/400/content/application~1json/examples/When the grant id cannot be found |tooltip| Bad request response when grantId cannot be found."},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1grants~1{grantId}/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/200/content/application~1json/examples/Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce":{"value":{"data":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}]},"key":"Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce","summary":"Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce","description":"When a user has been granted some License and Role entitlement's to Salesforce","id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/200/content/application~1json/examples/Principal entitlements |tooltip| When a user has been granted some License and Role entitlement's to Salesforce"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidFilter":{"value":{"errorCode":"E0000053","errorSummary":"Invalid SCIM filter","errorLink":"E0000053","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `filter` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/filter","domain":"governance"}]},"key":"InvalidFilter","summary":"InvalidFilter","id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidFilter"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidAfter":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `after` parameter isn't valid. Use links in response bodies or headers as the source of truth for paginated requests that contain an `after` parameter.","reason":"INVALID_AFTER_PARAMETER","locationType":"query","location":"/query/after","domain":"governance"}]},"key":"InvalidAfter","summary":"InvalidAfter","id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/InvalidAfter"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"key":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","summary":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","description":"Invalid `orderBy` parameter error response","id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/200/content/application~1json/examples/Principal entitlement changes":{"value":{"entitlementsChanged":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description","changeType":"ADDED"},{"id":"ento3v6xk6nOq7lm51d6","externalValue":"B","name":"B label","description":"B label description","changeType":"REMOVED"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fu190Eg75a8g6","name":"C label","externalValue":"C","description":"C label description","changeType":"ADDED"},{"id":"ent4rg7fltWSgrlDT8g6","name":"D label","externalValue":"D","description":"D label description","changeType":"ADDED"}]},{"id":"espo3v6xlwdtEX2il1d6","name":"Role","externalValue":"Role","description":"Role entitlement property","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Admin access","externalValue":"admin","description":"provides admin access role","changeType":"REMOVED"}]},{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","description":"This is an Approval Payments Role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment","description":"Approve Payment description","changeType":"REMOVED"}]}],"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","principal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"_links":{"principal-entitlements":{"href":"https://myorg.okta.com/governance/api/v1/principal-entitlements?filter=string"}}},"key":"Principal entitlement changes","summary":"Principal entitlement changes","id":"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/200/content/application~1json/examples/Principal entitlement changes"},"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements-changes~1{principalEntitlementsChangeId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/200/content/application~1json/examples/Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`":{"value":{"resourceOrn":"orn:okta:idp:00o1kq5LLpmbGnOtz0g4:apps:oidc_client:0oacvetsS5uY0gCzk0g4","resource":{"externalId":"0oacvetsS5uY0gCzk0g4","type":"APPLICATION"},"principalOrn":"orn:okta:directory:00o1kq5LLpmbGnOtz0g4:users:00u1rvrLNphg0QAmP0g4","principal":{"externalId":"00u1rvrLNphg0QAmP0g4","type":"OKTA_USER"},"entitlementHistory":[{"id":"gra1234567890abcdefg","startDate":"2025-05-27T18:02:20Z","endDate":"","lifecycle":"ACTIVE","entitlements":[{"id":"esp50hqELd8zN24EK0g3","name":"kelly1_policy_ent1","externalValue":"kelly1_policy_ent1","description":"Entitlement granted through some policy","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50iPvQe2pCKXLj0g3","name":"value1","externalValue":"value_1","description":"description for value1"},{"id":"ent50jekdX8Pvz7qK0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]},{"id":"esp50kwLEb7dHf6cR0g3","name":"kelly1_bundle_ent1","externalValue":"kelly1_bundle_ent1","description":"Part 1 of Entitlement granted through some bundle","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50liBN3ncpWpyx0g3","name":"value1","externalValue":"value_1","description":"description for value1"}]},{"id":"esp50n7nXZizDH2fI0g3","name":"kelly1_bundle_ent2","externalValue":"kelly1_bundle_ent2","description":"Part 2 of Entitlement granted through some bundle","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50oF2BKwZzmk3U0g3","name":"value1","externalValue":"value_1","description":"description for value1"}]}]},{"id":"gra2345678901bcdefgh","startDate":"2025-05-27T17:46:06Z","endDate":"2025-05-27T18:02:20Z","lifecycle":"INACTIVE","entitlements":[{"id":"esp50hqELd8zN24EK0g3","name":"kelly1_policy_ent1","externalValue":"kelly1_policy_ent1","description":"Entitlement granted through some policy","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50iPvQe2pCKXLj0g3","name":"value1","externalValue":"value_1","description":"description for value1"},{"id":"ent50jekdX8Pvz7qK0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]}]},{"id":"gra3456789012cdefghi","startDate":"2025-05-27T16:43:54Z","endDate":"2025-05-27T17:46:06Z","lifecycle":"INACTIVE","entitlements":[{"id":"esp50bptAmBbN6NQD0g3","name":"kelly1_ent2","externalValue":"kelly1_ent2","description":"Some entitlements 2","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50dFEGSm6ULsws0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]},{"id":"esp50hqELd8zN24EK0g3","name":"kelly1_policy_ent1","externalValue":"kelly1_policy_ent1","description":"Entitlement granted through some policy","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent50iPvQe2pCKXLj0g3","name":"value1","externalValue":"value_1","description":"description for value1"},{"id":"ent50jekdX8Pvz7qK0g3","name":"value2","externalValue":"value_2","description":"description for value2"}]}]}],"_links":{"self":{"href":"https://oig-admin.okta1.com/governance/api/v1/principal-entitlements-history?filter=resource.externalId%20eq%20%220oacvetsS5uY0gCzk0g4%22%20AND%20resource.type%20eq%20%22APPLICATION%22%20AND%20principal.externalId%20eq%20%2200u1rvrLNphg0QAmP0g4%22%20AND%20principal.type%20eq%20%22OKTA_USER%22&startTime=2023-10-22T20%3A36%3A31Z&limit=3&include=count","hints":{}},"next":{"href":"https://oig-admin.okta1.com/governance/api/v1/principal-entitlements-history?filter=resource.externalId%20eq%20%220oacvetsS5uY0gCzk0g4%22%20AND%20resource.type%20eq%20%22APPLICATION%22%20AND%20principal.externalId%20eq%20%2200u1rvrLNphg0QAmP0g4%22%20AND%20principal.type%20eq%20%22OKTA_USER%22&startTime=2023-10-22T20%3A36%3A31Z&limit=3&include=count&after=gray6L71iX6NduVhm0g2","hints":{}}},"metadata":{"total":4}},"key":"Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`","summary":"Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`","description":"The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`","id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/200/content/application~1json/examples/Principal entitlements history |tooltip| The response to a principal entitlements history request with a `startDate`, `limit=3`, and `include=counts`"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidFilter":{"value":{"errorCode":"E0000053","errorSummary":"Invalid SCIM filter","errorLink":"E0000053","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `filter` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/filter","domain":"governance"}]},"key":"InvalidFilter","summary":"InvalidFilter","id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidFilter"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidAfter":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `after` parameter isn't valid. Use links in response bodies or headers as the source of truth for paginated requests that contain an `after` parameter.","reason":"INVALID_AFTER_PARAMETER","locationType":"query","location":"/query/after","domain":"governance"}]},"key":"InvalidAfter","summary":"InvalidAfter","id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/InvalidAfter"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"key":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","summary":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","description":"Invalid `orderBy` parameter error response","id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-entitlements~1history/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements":{"value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"expirationTime":"2024-05-31T23:59:59Z","timeZone":"America/Toronto","base":{"grantType":"POLICY","grantMethod":"POLICY","expirationTime":"2024-05-31T23:59:59Z","grant":{"id":"grab0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNR"}}},"entitlements":[{"id":"espfxqCAJWWGELFTYASJ","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Read access","externalValue":"read","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}]}]},"additional":[{"grantType":"ENTITLEMENT-BUNDLE","grantMethod":"ACCESS_REQUEST","startTime":"2024-03-15T00:00:00Z","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","grant":{"id":"grab0oNGTSWTBKOLGLNQ","self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNQ"}},"bundle":{"id":"enb4aHwGLtZBsLSf40g2","name":"Bundle1"},"entitlements":[{"id":"espfxqCAJWWGELFTYASI","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAB","name":"Write access","externalValue":"write","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAB"}]}]}]},"key":"Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements","summary":"Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements","description":"Principal access data with base (POLICY or CUSTOM) and any additional entitlements","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base and additional entitlements |tooltip| Principal access data with base (POLICY or CUSTOM) and any additional entitlements"},"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only":{"value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"expirationTime":"2024-05-31T23:59:59Z","timeZone":"America/Toronto","base":{"grantType":"POLICY","grantMethod":"POLICY","expirationTime":"2024-05-31T23:59:59Z","grant":{"id":"grab0oNGTSWTBKOLGLNR","_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNR"}}},"entitlements":[{"id":"espfxqCAJWWGELFTYASJ","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Read access","externalValue":"read","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}]}]}},"key":"Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only","summary":"Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only","description":"Principal access data with base (POLICY or CUSTOM) entitlements only","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements only |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements only"},"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with no entitlements |tooltip| Principal access data with no entitlements":{"value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"}},"key":"Principal access data with no entitlements |tooltip| Principal access data with no entitlements","summary":"Principal access data with no entitlements |tooltip| Principal access data with no entitlements","description":"Principal access data with no entitlements","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with no entitlements |tooltip| Principal access data with no entitlements"},"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata":{"value":{"targetPrincipalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","targetPrincipal":{"externalId":"00ub0oNGTSWTBKOLGLNR","type":"OKTA_USER"},"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","parent":{"externalId":"0oafxqCAJWWGELFTYASJ","type":"APPLICATION"},"expirationTime":"2024-05-31T23:59:59Z","timeZone":"America/Toronto","base":{"grantType":"POLICY","grantMethod":"POLICY","expirationTime":"2024-05-31T23:59:59Z","grant":{"id":"grab0oNGTSWTBKOLGLNR","metadata":{"collection":{"id":"00cb0oNGTSWTBKOLGLNR","name":"Some Collection"}},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/grants/grab0oNGTSWTBKOLGLNR"}}},"entitlements":[{"id":"espfxqCAJWWGELFTYASJ","name":"Figma","externalValue":"figma","description":"This is a Figma entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"entfxqCAJWWGELFTYAAA","name":"Read access","externalValue":"read","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entfxqCAJWWGELFTYAAA"}]}]}},"key":"Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata","summary":"Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata","description":"Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/200/content/application~1json/examples/Principal access data with base entitlements and grant metadata |tooltip| Principal access data with base (POLICY or CUSTOM) entitlements and grant metadata"},"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidFilter":{"value":{"errorCode":"E0000053","errorSummary":"Invalid SCIM filter","errorLink":"E0000053","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `filter` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/filter","domain":"governance"}]},"key":"InvalidFilter","summary":"InvalidFilter","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidFilter"},"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidAfter":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `after` parameter isn't valid. Use links in response bodies or headers as the source of truth for paginated requests that contain an `after` parameter.","reason":"INVALID_AFTER_PARAMETER","locationType":"query","location":"/query/after","domain":"governance"}]},"key":"InvalidAfter","summary":"InvalidAfter","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/InvalidAfter"},"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"key":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","summary":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","description":"Invalid `orderBy` parameter error response","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response"},"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1principal-access/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1principal-access/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1principal-access/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-access/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-access/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-access/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-access/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-access/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-access/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-access/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to a single app":{"value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"ADMIN","revokeOrns":["orn:okta:idp:00o11rndFqmZ5rNfs0g4:apps:oidc_client:0oa251e7jQHXVgg5r0g4"]},"key":"Revoke access to a single app","summary":"Revoke access to a single app","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to a single app"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement values":{"value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"API","revokeOrns":["orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent65J1scEgrRZbjT0g2","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent76K2tdFhsSAcku1h3"]},"key":"Revoke access to multiple entitlement values","summary":"Revoke access to multiple entitlement values","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement values"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement bundles":{"value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"ADMIN","revokeOrns":["orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-bundles:enbjpz6MOxd2rUgyh0g3","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-bundles:enbkqz7NPye3sVhzi1h4"]},"key":"Revoke access to multiple entitlement bundles","summary":"Revoke access to multiple entitlement bundles","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to multiple entitlement bundles"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to entitlement values and bundles":{"value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","actor":"API","revokeOrns":["orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent65J1scEgrRZbjT0g2","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent76K2tdFhsSAcku1h3","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-bundles:enbjpz6MOxd2rUgyh0g3"]},"key":"Revoke access to entitlement values and bundles","summary":"Revoke access to entitlement values and bundles","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/requestBody/content/application~1json/examples/Revoke access to entitlement values and bundles"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/200/content/application~1json/examples/Successful revocation response":{"value":{"data":[{"_links":{"principal-access":{"href":"https://myorg.okta.com/governance/api/v1/principal-access?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"principal-entitlements":{"href":"https://myorg.okta.com/governance/api/v1/principal-entitlements?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""}}},{"_links":{"principal-access":{"href":"https://myorg.okta.com/governance/api/v1/principal-access?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""},"principal-entitlements":{"href":"https://myorg.okta.com/governance/api/v1/principal-entitlements?filter=parent.externalId eq \"0oafxqCAJWWGELFTYASJ\" AND parent.type eq \"APPLICATION\" AND targetPrincipal.externalId eq \"00ub0oNGTSWTBKOLGLNR\" AND targetPrincipal.type eq \"OKTA_USER\""}}}]},"key":"Successful revocation response","summary":"Successful revocation response","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/200/content/application~1json/examples/Successful revocation response"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Missing required field":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed","errorLink":"E0000001","errorId":"oae12345","errorCauses":[{"errorSummary":"principalOrn is required"}]},"key":"Missing required field","summary":"Missing required field","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Missing required field"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Invalid ORN format":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed","errorLink":"E0000001","errorId":"oae12345","errorCauses":[{"errorSummary":"Invalid ORN format for revokeObjectOrns"}]},"key":"Invalid ORN format","summary":"Invalid ORN format","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/400/content/application~1json/examples/Invalid ORN format"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1revoke-principal-access/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection":{"value":{"name":"Core Engineering Access","description":"Birthright access for all FTE engineers"},"key":"New empty collection |tooltip| Request body for creating a new resource collection","summary":"New empty collection |tooltip| Request body for creating a new resource collection","description":"Request body for creating a new resource collection","id":"paths/~1governance~1api~1v1~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"},"paths/~1governance~1api~1v1~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection":{"value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"key":"Collection details |tooltip| Full response details for a resource collection","summary":"Collection details |tooltip| Full response details for a resource collection","description":"Full response details for a resource collection","id":"paths/~1governance~1api~1v1~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"},"paths/~1governance~1api~1v1~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections":{"value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736435","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736435","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc5472336736435/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc34657643674534/resources"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections?limit=3&after=rc34657643674534"},"self":{"href":"example.com/governance/api/v1/collections?limit=3"}},"metadata":{"total":3}},"key":"Collections list |tooltip| List of collections","summary":"Collections list |tooltip| List of collections","description":"List of collections","id":"paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections"},"paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list with counts |tooltip| List of collections with counts":{"value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers'","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","counts":{"principalAssignmentCount":10,"resourceCounts":{"APPLICATION":5}},"_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736435","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736435","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","counts":{"principalAssignmentCount":28,"resourceCounts":{"APPLICATION":8}},"_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc5472336736435/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","counts":{"principalAssignmentCount":1,"resourceCounts":{"APPLICATION":3}},"_links":{"resources":{"href":"example.com/governance/api/v1/collections/rc34657643674534/resources"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections?limit=3&after=rc34657643674534"},"self":{"href":"example.com/governance/api/v1/collections?limit=3"}},"metadata":{"total":3}},"key":"Collections list with counts |tooltip| List of collections with counts","summary":"Collections list with counts |tooltip| List of collections with counts","description":"List of collections with counts","id":"paths/~1governance~1api~1v1~1collections/get/responses/200/content/application~1json/examples/Collections list with counts |tooltip| List of collections with counts"},"paths/~1governance~1api~1v1~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection":{"value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"key":"Collection details |tooltip| Full response details for a resource collection","summary":"Collection details |tooltip| Full response details for a resource collection","description":"Full response details for a resource collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection":{"value":{"name":"Core Engineering Access","description":"Birthright access for all FTE engineers"},"key":"Replaces a resource collection |tooltip| The request body to replace a resource collection","summary":"Replaces a resource collection |tooltip| The request body to replace a resource collection","description":"The request body to replace a resource collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection":{"value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"key":"Collection details |tooltip| Full response details for a resource collection","summary":"Collection details |tooltip| Full response details for a resource collection","description":"Full response details for a resource collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"key":"List collection resources |tooltip| List of resources in a collection","summary":"List collection resources |tooltip| List of resources in a collection","description":"List of resources in a collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":2,"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":0,"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":3,"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"key":"List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts","summary":"List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts","description":"List of resources in a collection with entitlement value counts","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts |tooltip| List of resources in a collection with entitlement value counts"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"key":"List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info","summary":"List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info","description":"List of resources in a collection with additional entitlement info","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlements |tooltip| List of resources in a collection with additional entitlement info"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":2,"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":0,"entitlements":[],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha/"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlementValueCount":3,"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"},{"id":"ento3v6xk6nOq7lm51d6","name":"B label","externalValue":"B","description":"B label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste/"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"key":"List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info","summary":"List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info","description":"List of resources in a collection with additional entitlement info","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with entitlement value counts and entitlements |tooltip| List of resources in a collection with additional entitlement info"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/example":{"value":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}]},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA"},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSD~GAVXCBZSDFG","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}]}],"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g"}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:google:0oafxqDFHASFGZGSERDHA","resourceId":"res1234gjfdsfdasha","resourceProfile":{"id":"0oafxqDFHASFGZGSERDHA","name":"google","label":"Google","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res1234gjfdsfdasha"}}},{"resourceOrn":"orn:okta:idp:0034t89uq4u0q54u80q2:apps:netsuite:0oasdSDlGAVXCBZSDFG","resourceId":"res6573rtyfuhdyste","resourceProfile":{"id":"0oasdSDlGAVXCBZSDFG","name":"netsuite","label":"NetSuite","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res6573rtyfuhdyste"}}}],"_links":{"next":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3&after=res6573rtyfuhdyste"},"self":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources?limit=3"}},"metadata":{"count":3}},"key":"List collection resources |tooltip| List of resources in a collection","summary":"List collection resources |tooltip| List of resources in a collection","description":"List of resources in a collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/List collection resources |tooltip| List of resources in a collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType":{"value":{"errorCode":"E0000028","errorSummary":"Resource ORN must be a specific app","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The resource ORN must be a specific app.","reason":"INVALID_RESOURCE_ORN","locationType":"body","location":"resourceOrn","domain":"collection"}]},"key":"resourceOrnWrongType","summary":"resourceOrnWrongType","description":"Resource ORN other than a specific app","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/example":{"value":{"data":{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","entitlementValueCount":2,"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements"}}}},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example":{"value":{"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/example":{"value":{"data":{"resourceOrn":"orn:okta:idp:00ofsdghasfhas54wewe:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","entitlementValueCount":2,"entitlements":[{"id":"espo3v6xlwdtEX2il1d6","name":"License","externalValue":"License","description":"This is a license entitlement","multiValue":true,"required":false,"dataType":"string","values":[{"id":"ento3v6xmkviXCltm1d6","name":"A label","externalValue":"A","description":"A label description"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role","externalValue":"Role","description":"This is a role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"C label","externalValue":"C","description":"C label description"}]}],"_links":{"entitlements":{"href":"example.com/governance/api/v1/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements"}}}},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection":{"value":{"data":[{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/collections/{collectionId}/catalog/users?filter=firstName%20sw%20%22Juan%22"}}},"key":"List of unassigned users from a collection |tooltip| List of unassigned users from a collection","summary":"List of unassigned users from a collection |tooltip| List of unassigned users from a collection","description":"List of unassigned users from a collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection":{"value":{"data":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/collections/{collectionId}/assignments"}}},"key":"List of assigned principals to collection |tooltip| List of assigned principals to collection","summary":"List of assigned principals to collection |tooltip| List of assigned principals to collection","description":"List of assigned principals to collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite.":{"value":[{"actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto"},{"actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"}}],"key":"Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite.","summary":"Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite.","description":"Assign principals to the collection. The assignment can be for a limited time or indefinite.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection":{"value":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL"},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"assignmentType":"INDIVIDUAL"}],"key":"List of assigned principals to collection |tooltip| List of assigned users to a collection","summary":"List of assigned principals to collection |tooltip| List of assigned users to a collection","description":"List of assigned users to a collection","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone":{"value":[{"op":"ADD","path":"/expirationTime","value":"2024-04-30T23:59:59Z"},{"op":"ADD","path":"/timeZone","value":"America/Toronto"}],"key":"Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","summary":"Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","description":"Request body for adding an expiration time and time zone","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone":{"value":[{"op":"REPLACE","path":"/expirationTime","value":"2024-04-30T23:59:59Z"},{"op":"REPLACE","path":"/timeZone","value":"America/Toronto"}],"key":"Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","summary":"Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","description":"Request body for replacing an expiration time and time zone","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone":{"value":[{"op":"REMOVE","path":"/expirationTime"},{"op":"REMOVE","path":"/timeZone"}],"key":"Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone","summary":"Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone","description":"Request body for removing an expiration time and timezone","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection":{"value":{"data":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/collections/{collectionId}/assignments"}}},"key":"List of assigned principals to collection |tooltip| List of assigned principals to collection","summary":"List of assigned principals to collection |tooltip| List of assigned principals to collection","description":"List of assigned principals to collection","id":"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"},"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1collections~1assignments/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection":{"value":{"name":"Core Engineering Access","description":"Birthright access for all FTE engineers"},"key":"New empty collection |tooltip| Request body for creating a new resource collection","summary":"New empty collection |tooltip| Request body for creating a new resource collection","description":"Request body for creating a new resource collection","id":"paths/~1governance~1api~1v2~1collections/post/requestBody/content/application~1json/examples/New empty collection |tooltip| Request body for creating a new resource collection"},"paths/~1governance~1api~1v2~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection":{"value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"key":"Collection details |tooltip| Full response details for a resource collection","summary":"Collection details |tooltip| Full response details for a resource collection","description":"Full response details for a resource collection","id":"paths/~1governance~1api~1v2~1collections/post/responses/201/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"},"paths/~1governance~1api~1v2~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections":{"value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736FzMx0g3","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736FzMx0g3","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/col5472336736FzMx0g3/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/col4a6Rpz3FCxDEBp0g3/resources"}}}],"_links":{"next":{"href":"example.com/governance/api/v2/collections?limit=3&after=col4a6Rpz3FCxDEBp0g3"},"self":{"href":"example.com/governance/api/v2/collections?limit=3"}},"metadata":{"total":3}},"key":"Collections list |tooltip| List of collections","summary":"Collections list |tooltip| List of collections","description":"List of collections","id":"paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list |tooltip| List of collections"},"paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details":{"value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","resourceRelationship":{"resourceOrn":"orn:okta:idp:00o1234567890:apps:0oa1234567890","addedToCollectionDate":"2024-08-15T10:30:00Z"},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col4a6Rpz3FCxDEBp0g3","name":"Super User Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col4a6Rpz3FCxDEBp0g3","description":"Elevated access in all environments","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","resourceRelationship":{"resourceOrn":"orn:okta:idp:00o1234567890:apps:0oa1234567890","addedToCollectionDate":"2024-09-01T08:00:00Z"},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/col4a6Rpz3FCxDEBp0g3/resources"}}}],"_links":{"self":{"href":"example.com/governance/api/v2/collections?filter=resourceOrn%20eq%20%22orn%3Aokta%3Aidp%3A00o1234567890%3Aapps%3A0oa1234567890%22"}},"metadata":{"total":2}},"key":"Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details","summary":"Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details","description":"List of collections containing a specific resource with resource relationship details","id":"paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by resourceOrn |tooltip| List of collections containing a specific resource with resource relationship details"},"paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details":{"value":{"data":[{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","principalAssignment":{"principalOrn":"orn:okta:idp:00o1234567890:users:00u1234567890","actor":"ADMIN","assignmentType":"INDIVIDUAL","expirationTime":"2025-12-31T23:59:59Z"},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},{"id":"col5472336736435","name":"Core Sales Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:col5472336736435","description":"Birthright access for all sales staff","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","principalAssignment":{"principalOrn":"orn:okta:idp:00o1234567890:users:00u1234567890","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","expirationTime":null},"_links":{"resources":{"href":"example.com/governance/api/v2/collections/col5472336736435/resources"}}}],"_links":{"self":{"href":"example.com/governance/api/v2/collections?filter=principalOrn%20eq%20%22orn%3Aokta%3Aidp%3A00o1234567890%3Ausers%3A00u1234567890%22"}},"metadata":{"total":2}},"key":"Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details","summary":"Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details","description":"List of collections assigned to a specific principal with assignment details","id":"paths/~1governance~1api~1v2~1collections/get/responses/200/content/application~1json/examples/Collections list filtered by principalOrn |tooltip| List of collections assigned to a specific principal with assignment details"},"paths/~1governance~1api~1v2~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection":{"value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"key":"Collection details |tooltip| Full response details for a resource collection","summary":"Collection details |tooltip| Full response details for a resource collection","description":"Full response details for a resource collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection":{"value":{"name":"Core Engineering Access","description":"Birthright access for all FTE engineers"},"key":"Replaces a resource collection |tooltip| The request body to replace a resource collection","summary":"Replaces a resource collection |tooltip| The request body to replace a resource collection","description":"The request body to replace a resource collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/requestBody/content/application~1json/examples/Replaces a resource collection |tooltip| The request body to replace a resource collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection":{"value":{"id":"cole8sBBMFDxPgcHx0g3","name":"Core Engineering Access","orn":"orn:okta:governance:00o11rndFqmZ5rNfs0g4:collections:cole8sBBMFDxPgcHx0g3","description":"Birthright access for all FTE engineers","created":"2024-07-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2024-07-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","_links":{"resources":{"href":"example.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources"}}},"key":"Collection details |tooltip| Full response details for a resource collection","summary":"Collection details |tooltip| Full response details for a resource collection","description":"Full response details for a resource collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/200/content/application~1json/examples/Collection details |tooltip| Full response details for a resource collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION"},"resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"resourceProfile":{"id":"0oa4z5j8pzVrBCFYt0g7","name":"workday","label":"Workday","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"resourceProfile":{"id":"0oaXYZ123ABC456DEF78","name":"slack","label":"Slack","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"resourceProfile":{"id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP"},"resourceProfile":{"id":"00gABCDEFGHIJKL12345","name":"Engineering Team","description":"All users in the engineering department","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs6grpiconABC","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources?limit=5"}},"metadata":{"count":5}},"key":"List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).","summary":"List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).","description":"List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups).","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups)."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter.":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION","counts":{"entitlements":5}},"resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"pushGroups":2}},"resourceProfile":{"id":"0oa4z5j8pzVrBCFYt0g7","name":"workday","label":"Workday","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"resourceProfile":{"id":"0oaXYZ123ABC456DEF78","name":"slack","label":"Slack","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"resourceProfile":{"id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP"},"resourceProfile":{"id":"00gABCDEFGHIJKL12345","name":"Engineering Team","description":"All users in the engineering department","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs6grpiconABC","type":"image/png"}]},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources?include=counts&limit=5"}},"metadata":{"count":5}},"key":"List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter.","summary":"List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter.","description":"List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/200/content/application~1json/examples/List collection resources with various types with counts |tooltip| List showing various resource types (apps with entitlements, apps with push groups, direct apps, groups with push mappings, groups) with `include=counts` query parameter."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add apps with entitlements and apps with push groups to a collection":{"value":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","entitlements":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"},{"id":"ento3v6xk6nOq7lm51d6"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}]},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7"},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6"}],"key":"Add apps with entitlements and apps with push groups to a collection","summary":"Add apps with entitlements and apps with push groups to a collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add apps with entitlements and apps with push groups to a collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add groups and push groups to a collection":{"value":[{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345"}],"key":"Add groups and push groups to a collection","summary":"Add groups and push groups to a collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add groups and push groups to a collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection":{"value":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7"},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6"},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345"}],"key":"Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection","summary":"Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection","description":"A single API request adding multiple resource types (apps, groups, push groups) to a collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/requestBody/content/application~1json/examples/Add resources with various types to a collection |tooltip| A single API request adding multiple resource types (apps, groups, push groups) to a collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection":{"value":{"data":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6","resourceId":"resPG002def","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG002def","hints":{}}}},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources?limit=6"}},"metadata":{"count":6}},"key":"Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection","summary":"Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection","description":"Response after adding various types of resources (apps, groups, push groups) to a collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/200/content/application~1json/examples/Add resources with various types |tooltip| Response after adding various types of resources (apps, groups, push groups) to a collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType":{"value":{"errorCode":"E0000028","errorSummary":"Resource ORN must be a specific app","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The resource ORN must be a specific app.","reason":"INVALID_RESOURCE_ORN","locationType":"body","location":"resourceOrn","domain":"collection"}]},"key":"resourceOrnWrongType","summary":"resourceOrnWrongType","description":"Resource ORN other than a specific app","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/400/content/application~1json/examples/resourceOrnWrongType"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements":{"value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION","counts":{"entitlements":2}},"entitlements":[{"id":"esp1d9eM0jbeX6n1v0g4","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent1d9fRafZpFimYB0g4","name":"value1","externalValue":"value_1","description":"description for value1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9fRafZpFimYB0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"},{"id":"ent1d9gvE68cz2zCZ0g4","name":"value2","externalValue":"value_2","description":"description for value2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role Entitlement","externalValue":"role_entitlement","description":"Some role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"admin","externalValue":"admin","description":"Administrator role","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}},"entitlements":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements"}}},"key":"Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","summary":"Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","description":"Response showing an app resource with entitlements","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)":{"value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION","counts":{"entitlements":2,"labels":2}},"resourceProfile":{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}]},"entitlements":[{"id":"esp1d9eM0jbeX6n1v0g4","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent1d9fRafZpFimYB0g4","name":"value1","externalValue":"value_1","description":"description for value1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9fRafZpFimYB0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"},{"id":"ent1d9gvE68cz2zCZ0g4","name":"value2","externalValue":"value_2","description":"description for value2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role Entitlement","externalValue":"role_entitlement","description":"Some role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"admin","externalValue":"admin","description":"Administrator role","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"red"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}},"entitlements":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements"}}},"key":"Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)","summary":"Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)","description":"Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with entitlements (include=resourceProfile&include=labels) |tooltip| Response showing an app resource with entitlements and all includes (include=resourceProfile&include=labels)"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups |tooltip| Response showing an app resource with push groups":{"value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"pushGroups":2}},"pushGroups":[{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resfHy1wVVOfgFzhh0g1","id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6","resourceId":"resVpQ3nRkZbYt7m2Xa9","id":"00g4rg7fkom0c3AsX8g6","name":"Sales East","description":"Sales team for East region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs3lmnopqRSTUV","type":"image/png"}]}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},"key":"Collection resource app with push groups |tooltip| Response showing an app resource with push groups","summary":"Collection resource app with push groups |tooltip| Response showing an app resource with push groups","description":"Response showing an app resource with push groups","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups |tooltip| Response showing an app resource with push groups"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)":{"value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:workday:0oa4z5j8pzVrBCFYt0g7","resourceId":"res456xyz789abc","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"pushGroups":2,"labels":1}},"pushGroups":[{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resfHy1wVVOfgFzhh0g1","id":"00go3v6xlwdtEX2il1d6","name":"Sales West","description":"Sales team for West region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs2abcdefGHIJK","type":"image/png"}]},{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g4rg7fkom0c3AsX8g6","resourceId":"resVpQ3nRkZbYt7m2Xa9","id":"00g4rg7fkom0c3AsX8g6","name":"Sales East","description":"Sales team for East region","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs3lmnopqRSTUV","type":"image/png"}]}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res456xyz789abc","hints":{}}}},"key":"Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)","summary":"Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)","description":"Response showing an app resource with push groups and labels (include=labels)","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource app with push groups (include=labels) |tooltip| Response showing an app resource with push groups and labels (include=labels)"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)":{"value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:slack:0oaXYZ123ABC456DEF78","resourceId":"res999none888","resourceConfiguration":{"entitlementManagementEnabled":false,"type":"APPLICATION","counts":{"labels":1}},"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res999none888","hints":{}}}},"key":"Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)","summary":"Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)","description":"Response showing an app resource with direct access and labels (include=labels)","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource direct app (include=labels) |tooltip| Response showing an app resource with direct access and labels (include=labels)"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group |tooltip| Response showing a push group resource":{"value":{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP"},"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},"key":"Collection resource push group |tooltip| Response showing a push group resource","summary":"Collection resource push group |tooltip| Response showing a push group resource","description":"Response showing a push group resource","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group |tooltip| Response showing a push group resource"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)":{"value":{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00go3v6xlwdtEX2il1d6","resourceId":"resPG001abc","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":true,"type":"GROUP","counts":{"relatedApps":3,"labels":1}},"relatedApps":[{"id":"0oa4z5j8pzVrBCFYt0g7","name":"workday","label":"Workday","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}],"inCollection":true},{"id":"0oafxqCAJWWGELFTYASJ","name":"salesforce","label":"Salesforce","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs1wwhrwJR4LpB5X0w6","type":"image/png"}],"inCollection":true},{"id":"0oaSN789servicenow12","name":"servicenow","label":"ServiceNow","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs5snowiconXYZ","type":"image/png"}],"inCollection":false}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/resPG001abc","hints":{}}}},"key":"Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)","summary":"Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)","description":"Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource push group (include=labels&include=relatedApps) |tooltip| Response showing a push group resource with related apps and labels (include=labels&include=relatedApps)"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)":{"value":{"resourceOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00gABCDEFGHIJKL12345","resourceId":"res789grp123","resourceConfiguration":{"entitlementManagementEnabled":false,"hasPushMapping":false,"type":"GROUP","counts":{"relatedApps":3,"labels":1}},"relatedApps":[{"id":"0oaJIRA456jiraApp123","name":"jira","label":"Jira","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs7jiraiconDEF","type":"image/png"}],"inCollection":true},{"id":"0oaGH789githubApp123","name":"github","label":"GitHub","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs8ghiconGHI","type":"image/png"}],"inCollection":false},{"id":"0oaXYZ123ABC456DEF78","name":"slack","label":"Slack","logo":[{"name":"medium","href":"https://tc2static.oktacdn.com/fs/bcg/4/gfs4wxyzABCDEF","type":"image/png"}],"inCollection":false}],"labels":[{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"red"}}}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789grp123","hints":{}}}},"key":"Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)","summary":"Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)","description":"Response showing a group resource with related apps and labels (include=labels&include=relatedApps)","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/200/content/application~1json/examples/Collection resource group (include=labels&include=relatedApps) |tooltip| Response showing a group resource with related apps and labels (include=labels&include=relatedApps)"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example":{"value":{"entitlements":[{"id":"esp1d9eM0jbeX6n1v0g4","values":[{"id":"ent1d9fRafZpFimYB0g4"},{"id":"ent1d9gvE68cz2zCZ0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","values":[{"id":"ent4rg7fltWSgrlDT8g6"}]}]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/requestBody/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements":{"value":{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resourceId":"res789067asg6asdf7g","resourceConfiguration":{"entitlementManagementEnabled":true,"type":"APPLICATION","counts":{"entitlements":2}},"entitlements":[{"id":"esp1d9eM0jbeX6n1v0g4","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent1d9fRafZpFimYB0g4","name":"value1","externalValue":"value_1","description":"description for value1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9fRafZpFimYB0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"},{"id":"ent1d9gvE68cz2zCZ0g4","name":"value2","externalValue":"value_2","description":"description for value2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role Entitlement","externalValue":"role_entitlement","description":"Some role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"admin","externalValue":"admin","description":"Administrator role","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]}],"_links":{"resource":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g","hints":{}},"entitlements":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements"}}},"key":"Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","summary":"Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements","description":"Response showing an app resource with entitlements","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/200/content/application~1json/examples/Collection resource app with entitlements |tooltip| Response showing an app resource with entitlements"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/200/content/application~1json/examples/List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection":{"value":{"data":[{"id":"esp1d9eM0jbeX6n1v0g4","name":"License Entitlement","externalValue":"license_entitlement","description":"Some license entitlement","multiValue":true,"required":false,"dataType":"array","values":[{"id":"ent1d9fRafZpFimYB0g4","name":"value1","externalValue":"value_1","description":"description for value1","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9fRafZpFimYB0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"},{"id":"ent1d9gvE68cz2zCZ0g4","name":"value2","externalValue":"value_2","description":"description for value2","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent1d9gvE68cz2zCZ0g4","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]},{"id":"esp4rg7fkom0c3AsX8g6","name":"Role Entitlement","externalValue":"role_entitlement","description":"Some role entitlement","multiValue":false,"required":false,"dataType":"string","values":[{"id":"ent4rg7fltWSgrlDT8g6","name":"admin","externalValue":"admin","description":"Administrator role","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:ent4rg7fltWSgrlDT8g6","createdBy":"00u12vkBeozCiuElj0g4","created":"2026-02-25T00:40:06Z","lastUpdated":"2026-02-25T00:40:06Z","lastUpdatedBy":"00u12vkBeozCiuElj0g4"}]}],"_links":{"self":{"href":"https://rain.okta1.com/governance/api/v2/collections/cole8sBBMFDxPgcHx0g3/resources/res789067asg6asdf7g/entitlements?limit=20"}},"metadata":{"total":2}},"key":"List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection","summary":"List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection","description":"Response showing the paginated list of entitlements for an app resource in a collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/200/content/application~1json/examples/List of entitlements for a collection resource |tooltip| Response showing the paginated list of entitlements for an app resource in a collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1resources~1{resourceId}~1entitlements/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection":{"value":{"data":[{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v2/collections/{collectionId}/catalog/users?filter=firstName%20sw%20%22Juan%22"}}},"key":"List of unassigned users from a collection |tooltip| List of unassigned users from a collection","summary":"List of unassigned users from a collection |tooltip| List of unassigned users from a collection","description":"List of unassigned users from a collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/200/content/application~1json/examples/List of unassigned users from a collection |tooltip| List of unassigned users from a collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1catalog~1users/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection":{"value":{"data":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v2/collections/{collectionId}/assignments"}}},"key":"List of assigned principals to collection |tooltip| List of assigned principals to collection","summary":"List of assigned principals to collection |tooltip| List of assigned principals to collection","description":"List of assigned principals to collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite.":{"value":[{"actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto"},{"actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"}}],"key":"Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite.","summary":"Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite.","description":"Assign principals to the collection. The assignment can be for a limited time or indefinite.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/requestBody/content/application~1json/examples/Assign principals to the collection |tooltip| Assign principals to the collection. The assignment can be for a limited time or indefinite."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection":{"value":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL"},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"assignmentType":"INDIVIDUAL"}],"key":"List of assigned principals to collection |tooltip| List of assigned users to a collection","summary":"List of assigned principals to collection |tooltip| List of assigned users to a collection","description":"List of assigned users to a collection","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/201/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned users to a collection"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone":{"value":[{"op":"ADD","path":"/expirationTime","value":"2024-04-30T23:59:59Z"},{"op":"ADD","path":"/timeZone","value":"America/Toronto"}],"key":"Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","summary":"Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone","description":"Request body for adding an expiration time and time zone","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Add - Add an expiration time and time zone |tooltip| Request body for adding an expiration time and time zone"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone":{"value":[{"op":"REPLACE","path":"/expirationTime","value":"2024-04-30T23:59:59Z"},{"op":"REPLACE","path":"/timeZone","value":"America/Toronto"}],"key":"Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","summary":"Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone","description":"Request body for replacing an expiration time and time zone","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Update - Replace an expiration time and time zone |tooltip| Request body for replacing an expiration time and time zone"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone":{"value":[{"op":"REMOVE","path":"/expirationTime"},{"op":"REMOVE","path":"/timeZone"}],"key":"Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone","summary":"Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone","description":"Request body for removing an expiration time and timezone","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/requestBody/content/application~1json/examples/Remove - Remove an expiration time and time zone |tooltip| Request body for removing an expiration time and timezone"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1{collectionId}~1assignments~1{assignmentId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection":{"value":{"data":[{"id":"ass28w6vzKKultXP98g5","actor":"ACCESS_REQUEST","expirationTime":"2024-04-30T23:59:59Z","timeZone":"America/Toronto","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g4","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}},{"id":"ass28w6vzKKultXP98g6","actor":"ACCESS_REQUEST","assignmentType":"INDIVIDUAL","collectionId":"col28w6vzKKultXP98g5","principal":{"externalId":"00u174cGuGxVFp4EY0g5","type":"OKTA_USER"},"principalProfile":{"id":"00u28w6vzKKultXP98g5","email":"jessie.smith@example.com","login":"jessie.smith@example.com","firstName":"Jessie","lastName":"Smith","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v2/collections/{collectionId}/assignments"}}},"key":"List of assigned principals to collection |tooltip| List of assigned principals to collection","summary":"List of assigned principals to collection |tooltip| List of assigned principals to collection","description":"List of assigned principals to collection","id":"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/200/content/application~1json/examples/List of assigned principals to collection |tooltip| List of assigned principals to collection"},"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1collections~1assignments/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules/post/requestBody/content/application~1json/examples/Create risk rule request":{"value":{"name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","values":[{"id":"ento3v6xk6nOq7lm51d6"}]}]}}]}},"key":"Create risk rule request","summary":"Create risk rule request","id":"paths/~1governance~1api~1v1~1risk-rules/post/requestBody/content/application~1json/examples/Create risk rule request"},"paths/~1governance~1api~1v1~1risk-rules/post/responses/201/content/application~1json/examples/Risk rule response":{"value":{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","status":"ACTIVE","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"lastUpdated":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules/rulb0oNGTSWTBKOLGLNR"}}},"key":"Risk rule response","summary":"Risk rule response","id":"paths/~1governance~1api~1v1~1risk-rules/post/responses/201/content/application~1json/examples/Risk rule response"},"paths/~1governance~1api~1v1~1risk-rules/post/responses/400/content/application~1json/examples/duplicateName":{"value":{"errorCode":"E0000028","errorSummary":"Rule name needs to be unique","errorLink":"E0000028","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The rule name needs to be unique.","reason":"INVALID_RULE_NAME","locationType":"body","location":"name","domain":"rules"}]},"key":"duplicateName","summary":"duplicateName","description":"Duplicate rule name","id":"paths/~1governance~1api~1v1~1risk-rules/post/responses/400/content/application~1json/examples/duplicateName"},"paths/~1governance~1api~1v1~1risk-rules/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1risk-rules/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1risk-rules/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules/get/responses/200/content/application~1json/examples/List risk rule response":{"value":{"data":[{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","status":"ACTIVE","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"lastUpdated":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules/rulb0oNGTSWTBKOLGLNR"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules?limit=2"},"next":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules?limit=2&after=rulb0oNGTSWTBKOLGLNR"}},"metadata":{"total":10}},"key":"List risk rule response","summary":"List risk rule response","id":"paths/~1governance~1api~1v1~1risk-rules/get/responses/200/content/application~1json/examples/List risk rule response"},"paths/~1governance~1api~1v1~1risk-rules/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1risk-rules/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1risk-rules/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/200/content/application~1json/examples/Risk rule response":{"value":{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","status":"ACTIVE","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"lastUpdated":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules/rulb0oNGTSWTBKOLGLNR"}}},"key":"Risk rule response","summary":"Risk rule response","id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/200/content/application~1json/examples/Risk rule response"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody/content/application~1json/examples/Update risk rule request":{"value":{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","notes":"Process and Approve Payment note","description":"Process and Approve Payment","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","values":[{"id":"ento3v6xmkviXCltm1d6"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","values":[{"id":"ento3v6xk6nOq7lm51d6"}]}]}}]}},"key":"Update risk rule request","summary":"Update risk rule request","id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/requestBody/content/application~1json/examples/Update risk rule request"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/200/content/application~1json/examples/Risk rule response":{"value":{"id":"rulb0oNGTSWTBKOLGLNR","name":"Process and Approve Payment","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","status":"ACTIVE","resources":[{"resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ"}],"lastUpdated":"2022-05-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","created":"2022-05-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/risk-rules/rulb0oNGTSWTBKOLGLNR"}}},"key":"Risk rule response","summary":"Risk rule response","id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/200/content/application~1json/examples/Risk rule response"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/put/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rules~1{ruleId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for bundle request":{"value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"},"key":"Risk assessment for bundle request","summary":"Risk assessment for bundle request","id":"paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for bundle request"},"paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for collection request":{"value":{"principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:col28w6vzKKultXP98g5"},"key":"Risk assessment for collection request","summary":"Risk assessment for collection request","id":"paths/~1governance~1api~1v1~1risk-rule-assessments/post/requestBody/content/application~1json/examples/Risk assessment for collection request"},"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/200/content/application~1json/examples/List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts":{"value":{"data":[{"id":"gra1ogjm4Osoj1ztg0g3:rulb0oNGTSWTBKOLGLNR","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","ruleName":"Process and Approve Payment","ruleId":"rulb0oNGTSWTBKOLGLNR","description":"Process and Approve Payment","type":"SEPARATION_OF_DUTIES","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approval Payments Role","externalValue":"approve_payment_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Approve Payment","externalValue":"approve_payment"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"Buyer Role","externalValue":"buyer_role","values":{"data":[{"id":"ento3v6xk6nOq7lm51d6","name":"Process Payment","externalValue":"process_payment"}]}}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/rules/rulb0oNGTSWTBKOLGLNR"}}},{"id":"gra1ogjm4Osoj1ztg0g3:rulb0oNGTSWTBKOLGLNR","principalOrn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00ub0oNGTSWTBKOLGLNR","resourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","ruleName":"Process and Approve Payment","ruleId":"rulb0oNGTSWTBKOLGLNR","description":"License and Approve","type":"SEPARATION_OF_DUTIES","conflictCriteria":{"and":[{"name":"list1","attribute":"principal.effective_grants","operation":"CONTAINS_ONE","value":{"type":"ENTITLEMENTS","value":[{"id":"espxf36xlwdtEX2il23e","name":"License Role","externalValue":"license_role","values":[{"id":"ento3v6xk6nOq7lm51d6","name":"Approve Payment","externalValue":"license"}]}]}},{"name":"list2","attribute":"principal.effective_grants","operation":"CONTAINS_ALL","value":{"type":"ENTITLEMENTS","value":[{"id":"espo3v6xlwdtEX2il1d6","name":"Approve Role","externalValue":"approve_role","values":[{"id":"ento3v6xmkviXCltm1d6","name":"Process License","externalValue":"process_license"}]}]}}]},"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/rules/rulb0oNGTSWTBKOLGLNQ"}}}],"_links":{"href":"https://myorg.okta.com/governance/api/v1/risk-rule-assessments?limit=20"}},"key":"List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts","summary":"List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts","description":"A list of risk-rule conflicts","id":"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/200/content/application~1json/examples/List of risk-rule conflicts for a specific resource |tooltip| A list of risk-rule conflicts"},"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1risk-rule-assessments/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners users request":{"value":{"principalOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g","orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4"],"resourceOrns":["orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"]},"key":"Create or update resource owners users request","summary":"Create or update resource owners users request","id":"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners users request"},"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners group request":{"value":{"principalOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4"],"resourceOrns":["orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"]},"key":"Create or update resource owners group request","summary":"Create or update resource owners group request","id":"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners group request"},"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Delete all resource owners request":{"value":{"principalOrns":null,"resourceOrns":["orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6"]},"key":"Delete all resource owners request","summary":"Delete all resource owners request","id":"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Delete all resource owners request"},"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners for an AI agent":{"value":{"principalOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4"],"resourceOrns":["orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp1tgwssMI9jYizU0g5"]},"key":"Create or update resource owners for an AI agent","summary":"Create or update resource owners for an AI agent","id":"paths/~1governance~1api~1v1~1resource-owners/post/requestBody/content/application~1json/examples/Create or update resource owners for an AI agent"},"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners users response":{"value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}},{"id":"pri6yl0Q065H4BCPR0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4","profile":{"id":"00u6yl0Q065H4BCPR0g4","email":"someother.name@okta.com","name":"Some Other Name","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u6yl0Q065H4BCPR0g4"}}}}]}]},"key":"Create or update resource owners users response","summary":"Create or update resource owners users response","id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners users response"},"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners group response":{"value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":3},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}]},"key":"Create or update resource owners group response","summary":"Create or update resource owners group response","id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners group response"},"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Delete all resource owners response":{"value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":null}]},"key":"Delete all resource owners response","summary":"Delete all resource owners response","id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Delete all resource owners response"},"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners for an AI agent response":{"value":{"data":[{"resource":{"id":"wlp1tgwssMI9jYizU0g5","type":"ai-agents","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp1tgwssMI9jYizU0g5","profile":{"id":"wlp1tgwssMI9jYizU0g5","name":"My AI Agent","description":"An AI agent for automating workflows"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}}]}]},"key":"Create or update resource owners for an AI agent response","summary":"Create or update resource owners for an AI agent response","id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/200/content/application~1json/examples/Create or update resource owners for an AI agent response"},"paths/~1governance~1api~1v1~1resource-owners/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1resource-owners/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response":{"value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}},{"id":"pri6yl0Q065H4BCPR0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4","profile":{"id":"00u6yl0Q065H4BCPR0g4","email":"someother.name@okta.com","name":"Some Other Name","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u6yl0Q065H4BCPR0g4"}}}}]},{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"entn4WFkzQJhB6QIa0g1","type":"entitlement-values","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entn4WFkzQJhB6QIa0g1","profile":{"id":"entn4WFkzQJhB6QIa0g1","name":"License Entitlement value 1","description":"Some license entitlement value","parent":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement"}}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":2},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]},{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enb1spaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enb1spaj3XUzcM62u1d6","profile":{"id":"enb1spaj3XUzcM62u1d6","name":"Github sub bundle","description":"Github sub for administrative access"}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":5},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners?limit=20&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\""}},"metadata":{"total":10}},"key":"Resource owners list success response","summary":"Resource owners list success response","id":"paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response"},"paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success with parent resource owner included response":{"value":{"data":[{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}},{"id":"pri6yl0Q065H4BCPR0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u6yl0Q065H4BCPR0g4","profile":{"id":"00u6yl0Q065H4BCPR0g4","email":"someother.name@okta.com","name":"Some Other Name","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u6yl0Q065H4BCPR0g4"}}}}]},{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","resource":{"id":"res1spaj3XUzcM62u1d6","type":"apps","orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","profile":{"id":"0oafxqCAJWWGELFTYASJ"}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":10},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners?limit=20&include=parent_resource_owner&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\""}},"metadata":{"total":10}},"key":"Resource owners list success with parent resource owner included response","summary":"Resource owners list success with parent resource owner included response","id":"paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success with parent resource owner included response"},"paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response for AI agents":{"value":{"data":[{"resource":{"id":"wlp1tgwssMI9jYizU0g5","type":"ai-agents","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp1tgwssMI9jYizU0g5","profile":{"id":"wlp1tgwssMI9jYizU0g5","name":"My AI Agent","description":"An AI agent for automating workflows"}},"principals":[{"id":"pri10sfroCwbHQO4a0g4","type":"users","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g4","profile":{"id":"00u10sfroCwbHQO4a0g4","name":"Some Name","email":"some.name@okta.com","_links":{"self":{"href":"https://myorg.okta.com/admin/user/profile/view/00u10sfroCwbHQO4a0g4"}}}}]},{"resource":{"id":"wlp2tgwssMI9jYizU0g5","type":"ai-agents","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:workload-principals:ai-agents:wlp2tgwssMI9jYizU0g5","profile":{"id":"wlp2tgwssMI9jYizU0g5","name":"Another AI Agent","description":"An AI agent for processing data pipelines"}},"principals":[{"id":"pri10ctakVI6XlTdk0g4","type":"groups","orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Okta Admins Group","metaData":{"userAssignmentCount":3},"_links":{"self":{"href":"https://myorg.okta.com/admin/group/00g10ctakVI6XlTdk0g4"}}}}]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners?limit=20&filter=resource.type eq \"ai-agents\""}},"metadata":{"total":2}},"key":"Resource owners list success response for AI agents","summary":"Resource owners list success response for AI agents","id":"paths/~1governance~1api~1v1~1resource-owners/get/responses/200/content/application~1json/examples/Resource owners list success response for AI agents"},"paths/~1governance~1api~1v1~1resource-owners/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1resource-owners/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1resource-owners/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/patch/requestBody/content/application~1json/examples/Create or update resource owners request":{"value":{"resourceOrn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","data":[{"op":"REMOVE","path":"/principalOrn","value":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u20sfroCwbHQO4a0g"},{"op":"REMOVE","path":"/principalOrn","value":"orn:okta:directory:00o11edPwGqbUrsDm0g4:users:00u10sfroCwbHQO4a0g"}]},"key":"Create or update resource owners request","summary":"Create or update resource owners request","id":"paths/~1governance~1api~1v1~1resource-owners/patch/requestBody/content/application~1json/examples/Create or update resource owners request"},"paths/~1governance~1api~1v1~1resource-owners/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1resource-owners/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1resource-owners/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement bundle catalog success response":{"value":{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","data":[{"id":"enbogpaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"}},{"id":"enb1spaj3XUzcM62u1d6","type":"entitlement-bundles","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enb1spaj3XUzcM62u1d6","profile":{"id":"enb1spaj3XUzcM62u1d6","name":"Github sub bundle","description":"Github sub for administrative access"}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners/catalog/resources?limit=20&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.type eq \"entitlement-bundles\""}}},"key":"Resource owners entitlement bundle catalog success response","summary":"Resource owners entitlement bundle catalog success response","id":"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement bundle catalog success response"},"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement values catalog success response":{"value":{"parentResourceOrn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ","data":[{"id":"entn5KFkzQJhB6QIa0g1","type":"entitlement-values","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entn5KFkzQJhB6QIa0g1","profile":{"id":"entn5KFkzQJhB6QIa0g1","name":"License Entitlement value 1","description":"Some license entitlement value 1","parent":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement"}}},{"id":"entn4WFkzQJhB6QIa0g1","type":"entitlement-values","orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-values:entn4WFkzQJhB6QIa0g1","profile":{"id":"entn4WFkzQJhB6QIa0g1","name":"License Entitlement value 2","description":"Some license entitlement value 2","parent":{"id":"esp2lr1lavoGDYw5U8g6","name":"License Entitlement"}}}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/resource-owners/catalog/resources?limit=20&filter=parentResourceOrn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:salesforce:0oafxqCAJWWGELFTYASJ\" AND resource.profile.parent.id eq \"esp2lr1lavoGDYw5U8g6\" AND resource.type eq \"entitlement-values\""}}},"key":"Resource owners entitlement values catalog success response","summary":"Resource owners entitlement values catalog success response","id":"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/200/content/application~1json/examples/Resource owners entitlement values catalog success response"},"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-owners~1catalog~1resources/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels/post/requestBody/content/application~1json/examples/Create a resource label request":{"value":{"name":"Compliance","values":[{"name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}]},"key":"Create a resource label request","summary":"Create a resource label request","id":"paths/~1governance~1api~1v1~1labels/post/requestBody/content/application~1json/examples/Create a resource label request"},"paths/~1governance~1api~1v1~1labels/post/responses/201/content/application~1json/examples/Label response":{"value":{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}},"key":"Label response","summary":"Label response","id":"paths/~1governance~1api~1v1~1labels/post/responses/201/content/application~1json/examples/Label response"},"paths/~1governance~1api~1v1~1labels/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1labels/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1labels/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels/get/responses/200/content/application~1json/examples/List labels response":{"value":{"data":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}}],"_links":{"self":{"href":"/governance/api/v1/labels"}}},"key":"List labels response","summary":"List labels response","id":"paths/~1governance~1api~1v1~1labels/get/responses/200/content/application~1json/examples/List labels response"},"paths/~1governance~1api~1v1~1labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1labels/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/200/content/application~1json/examples/Label response":{"value":{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}},"key":"Label response","summary":"Label response","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/200/content/application~1json/examples/Label response"},"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update label category |tooltip| Request body for updating label category":{"value":[{"op":"REPLACE","path":"/name","value":"Compliance","refType":"LABEL-CATEGORY"}],"key":"Update label category |tooltip| Request body for updating label category","summary":"Update label category |tooltip| Request body for updating label category","description":"Request body for updating label category","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update label category |tooltip| Request body for updating label category"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - add new label value |tooltip| Request body for adding label value":{"value":[{"op":"ADD","path":"/values/-","value":{"name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}},"refType":"LABEL-VALUE"}],"key":"Update - add new label value |tooltip| Request body for adding label value","summary":"Update - add new label value |tooltip| Request body for adding label value","description":"Request body for adding label value","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - add new label value |tooltip| Request body for adding label value"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - remove label value |tooltip| Request body for removing label value":{"value":[{"op":"REMOVE","path":"/values/lblo3v6xlwdtEX2il1d1","refType":"LABEL-VALUE"}],"key":"Update - remove label value |tooltip| Request body for removing label value","summary":"Update - remove label value |tooltip| Request body for removing label value","description":"Request body for removing label value","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - remove label value |tooltip| Request body for removing label value"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - update label value |tooltip| Request body for updating label value":{"value":[{"op":"REPLACE","path":"/values/lblo3v6xlwdtEX2il1d1/name","value":{"name":"PII"},"refType":"LABEL-VALUE"},{"op":"REPLACE","path":"/values/lblo3v6xlwdtEX2il1d1/metadata/additionalProperties/backgroundColor","value":{"metadata":{"additionalProperties":{"backgroundColor":"blue"}}},"refType":"LABEL-VALUE"}],"key":"Update - update label value |tooltip| Request body for updating label value","summary":"Update - update label value |tooltip| Request body for updating label value","description":"Request body for updating label value","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/requestBody/content/application~1json/examples/Update - update label value |tooltip| Request body for updating label value"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/200/content/application~1json/examples/Label response":{"value":{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}},{"labelValueId":"lblo3v6xlwdtEX2il1d6","name":"PII","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":{"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d6"}}},"key":"Label response","summary":"Label response","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/200/content/application~1json/examples/Label response"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1labels~1{labelId}/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels/get/responses/200/content/application~1json/examples/List resources with labels response":{"value":{"data":[{"orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","profile":{"id":"0oafxqCAJWWGELFTYASJ","name":"Github application","description":"Github application"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]}],"_links":{"self":{"href":"/governance/api/v1/resource-labels?filter=orn eq \"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ\""}}},"key":"List resources with labels response","summary":"List resources with labels response","id":"paths/~1governance~1api~1v1~1resource-labels/get/responses/200/content/application~1json/examples/List resources with labels response"},"paths/~1governance~1api~1v1~1resource-labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1resource-labels/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1resource-labels/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody/content/application~1json/examples/Assign resource labels example":{"value":{"resourceOrns":["orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:cologpaj3XUzcM62u1d6","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent63C22YQoNMWOJf0g2"],"labelValueIds":["lblo3v6xlwdtEX2il1d1","lblo3v6xlwdtEX2il1d2"]},"key":"Assign resource labels example","summary":"Assign resource labels example","id":"paths/~1governance~1api~1v1~1resource-labels~1assign/post/requestBody/content/application~1json/examples/Assign resource labels example"},"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/200/content/application~1json/examples/List resources with labels response":{"value":{"data":[{"orn":"orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","profile":{"id":"0oafxqCAJWWGELFTYASJ","name":"Github application","description":"Github application"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]},{"orn":"orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","profile":{"id":"00g10ctakVI6XlTdk0g4","name":"Github user group","description":"Github user group"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]},{"orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","profile":{"id":"enbogpaj3XUzcM62u1d6","name":"Github admin bundle","description":"Github bundle for administrative access"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]},{"orn":"orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:cologpaj3XUzcM62u1d6","profile":{"id":"cologpaj3XUzcM62u1d6","name":"DevOps collection","description":"Collection of DevOps resources"},"labels":[{"labelId":"lbco3v6xlwdtEX2il1d6","name":"Compliance","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d1","name":"SOX","metadata":{"additionalProperties":{"backgroundColor":"blue"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}},{"labelId":"lbco3v6xlwdtEX2il1d7","name":"Security","values":[{"labelValueId":"lblo3v6xlwdtEX2il1d2","name":"GDPR","metadata":{"additionalProperties":{"backgroundColor":"yellow"}}}],"_links":{"self":null,"href":"/governance/api/v1/labels/lbco3v6xlwdtEX2il1d7"}}]}]},"key":"List resources with labels response","summary":"List resources with labels response","id":"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/200/content/application~1json/examples/List resources with labels response"},"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels~1assign/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody/content/application~1json/examples/Unassign resources labels example":{"value":{"resourceOrns":["orn:okta:idp:00o11edPwGqbUrsDm0g4:apps:oidc:0oafxqCAJWWGELFTYASJ","orn:okta:directory:00o11edPwGqbUrsDm0g4:groups:00g10ctakVI6XlTdk0g4","orn:okta:governance:00o11edPwGqbUrsDm0g4:entitlement-bundles:enbogpaj3XUzcM62u1d6","orn:okta:governance:00o11edPwGqbUrsDm0g4:collections:cologpaj3XUzcM62u1d6","orn:okta:governance:00o11rndFqmZ5rNfs0g4:entitlement-values:ent63C22YQoNMWOJf0g2"],"labelValueIds":["lblo3v6xlwdtEX2il1d2"]},"key":"Unassign resources labels example","summary":"Unassign resources labels example","id":"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/requestBody/content/application~1json/examples/Unassign resources labels example"},"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1resource-labels~1unassign/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/Admin-appointed delegate":{"value":{"delegates":{"appointments":[{"delegate":{"type":"OKTA_USER","externalId":"00u2lxfQaw8WRlkQt0g4"},"note":"Johnny Appleseed is on parental leave"}]}},"key":"Admin-appointed delegate","summary":"Admin-appointed delegate","id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/Admin-appointed delegate"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/No delegate appointment":{"value":{"delegates":{"appointments":[]}},"key":"No delegate appointment","summary":"No delegate appointment","id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/requestBody/content/application~1json/examples/No delegate appointment"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/A delegate appointment":{"value":{"delegates":{"appointments":[{"id":"gda123ABCXYZ456DEF","delegate":{"type":"OKTA_USER","externalId":"00u2lxfQaw8WRlkQt0g4"},"note":"Johnny Appleseed is on parental leave","created":"2025-08-08T14:15:22Z","createdBy":"00u2lxfQaw8WRlkQt0g4","lastUpdated":"2025-08-28T14:15:22Z","lastUpdatedBy":"00u2lxfQaw8WRlkQt0g4"}]}},"key":"A delegate appointment","summary":"A delegate appointment","id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/A delegate appointment"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/No delegate appointment":{"value":{"delegates":{"appointments":[]}},"key":"No delegate appointment","summary":"No delegate appointment","id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/200/content/application~1json/examples/No delegate appointment"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Missing required fields":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Governance settings missing required fields","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Governance settings is missing required fields"}]},"key":"Missing required fields","summary":"Missing required fields","id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Missing required fields"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Invalid properties in the settings request":{"value":{"errorCode":"E0000001","errorSummary":"Api validation failed: Governance settings has invalid properties","errorLink":"E0000001","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Governance settings has invalid properties: delegator"}]},"key":"Invalid properties in the settings request","summary":"Invalid properties in the settings request","id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/400/content/application~1json/examples/Invalid properties in the settings request"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Principal not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1principal-settings~1{targetPrincipalId}/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/Delegate appointments":{"value":{"data":[{"id":"gda123ABCXYZ456DEF","delegate":{"type":"OKTA_USER","externalId":"00ub0oNGTSWTBKOLGLNR"},"delegator":{"type":"OKTA_USER","externalId":"00ub0oNGTSWTBKOLAAAA"},"note":"Johnny Appleseed is on parental leave","created":"2019-08-24T14:15:22Z","createdBy":"00ub0oNGTSWTBKOLGLNR","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00ub0oNGTSWTBKOLGLNR"},{"id":"gda123ABCXYZ456DEF","delegate":{"type":"OKTA_USER","externalId":"00u109dSBQX9e9XYS0g4"},"delegator":{"type":"OKTA_USER","externalId":"00u2lxfQaw8WRlkQt0g4"},"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-28T14:15:22Z","note":"Mary Lamb is on holiday","created":"2019-08-24T14:15:22Z","createdBy":"00u2lxfQaw8WRlkQt0g4","lastUpdated":"2019-08-24T14:15:22Z","lastUpdatedBy":"00u2lxfQaw8WRlkQt0g4"}],"_links":{"self":{"href":"https://subdomain.okta.com/governance/api/v1/settings/delegates"}}},"key":"Delegate appointments","summary":"Delegate appointments","id":"paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/Delegate appointments"},"paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/User has no delegates":{"value":{"data":[],"_links":{"self":{"href":"https://subdomain.okta.com/governance/api/v1/settings/delegates"}}},"key":"User has no delegates","summary":"User has no delegates","id":"paths/~1governance~1api~1v1~1delegates/get/responses/200/content/application~1json/examples/User has no delegates"},"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidFilter":{"value":{"errorCode":"E0000053","errorSummary":"Invalid SCIM filter","errorLink":"E0000053","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `filter` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/filter","domain":"governance"}]},"key":"InvalidFilter","summary":"InvalidFilter","id":"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidFilter"},"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidAfter":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `after` parameter isn't valid. Use links in response bodies or headers as the source of truth for paginated requests that contain an `after` parameter.","reason":"INVALID_AFTER_PARAMETER","locationType":"query","location":"/query/after","domain":"governance"}]},"key":"InvalidAfter","summary":"InvalidAfter","id":"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/InvalidAfter"},"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"Invalid `orderBy` syntax","reason":"STRING_FORMAT_INVALID","locationType":"query","location":"/orderBy","domain":"governance"}]},"key":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","summary":"Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response","description":"Invalid `orderBy` parameter error response","id":"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `orderBy` parameter error response |tooltip| Invalid `orderBy` parameter error response"},"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response":{"value":{"errorCode":"E0000029","errorSummary":"Invalid paging request","errorLink":"E0000029","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[{"errorSummary":"The `limit` parameter isn't valid.","reason":"INVALID_DATA_TYPE","locationType":"query","location":"/limit","domain":"governance"}]},"key":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","summary":"Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response","description":"Invalid `limit` parameter error response","id":"paths/~1governance~1api~1v1~1delegates/get/responses/400/content/application~1json/examples/Invalid `limit` parameter error response |tooltip| Invalid `limit` parameter error response"},"paths/~1governance~1api~1v1~1delegates/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1delegates/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1delegates/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1delegates/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1delegates/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1delegates/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1delegates/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1delegates/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/200/content/application~1json/examples/Lists all security access reviews based on filter criteria":{"value":{"data":[{"id":"sar1qebJYYHgbsOGF0g4","status":"ACTIVE","name":"Test SAR","endTime":"2025-06-20T14:55:27Z","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"],"includedUserProfiles":[{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE"},{"id":"00ucpjbi6JMmDvdN40g5","email":"jane.doe@okta.com","firstName":"Jane","lastName":"Doe","login":"jane.doe@okta.com","status":"ACTIVE"}]}},"createdBy":"00uco2uaXN7POnPUw0g4","created":"2025-06-13T14:55:28Z","lastUpdated":"2025-06-13T14:55:28Z","lastUpdatedBy":"00uco2uaXN7POnPUw0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4","hints":{}},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/history","hints":{}},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/accesses","hints":{}},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/actions","hints":{}},"principalDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1qebJYYHgbsOGF0g4/principal","hints":{}}}}],"_links":{"self":{"href":"https://ogrhmzrmnditnmfjys00otqylthhnjgtm2zhy2i1m2qxzwy4-admin.okta1.com/governance/api/v2/my/security-access-reviews?limit=20","hints":{}}}},"key":"Lists all security access reviews based on filter criteria","summary":"Lists all security access reviews based on filter criteria","id":"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/200/content/application~1json/examples/Lists all security access reviews based on filter criteria"},"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody/content/application~1json/examples/Payload to create a security access review":{"value":{"principalId":"00ucpjbi6JMmDvdN40g4","name":"Test SAR","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"]}}},"key":"Payload to create a security access review","summary":"Payload to create a security access review","id":"paths/~1governance~1api~1v2~1security-access-reviews/post/requestBody/content/application~1json/examples/Payload to create a security access review"},"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/202/content/application~1json/examples/Create a security access review response":{"value":{"id":"sar1lo5X9wmNTFX7x0g4","status":"PENDING","name":"Test SAR","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"],"includedUserProfiles":[{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE"},{"id":"00ucpjbi6JMmDvdN40g5","email":"jane.doe@okta.com","firstName":"Jane","lastName":"Doe","login":"jane.doe@okta.com","status":"ACTIVE"}]}},"createdBy":"00ucfd4IQoH6YBZgA0g4","created":"2025-06-13T00:40:57Z","lastUpdated":"2025-06-13T00:40:57Z","lastUpdatedBy":"00ucfd4IQoH6YBZgA0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4"},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/history"},"userDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/user"},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/accesses"},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/actions"}}},"key":"Create a security access review response","summary":"Create a security access review response","id":"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/202/content/application~1json/examples/Create a security access review response"},"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/200/content/application~1json/examples/Statistics for all security access reviews":{"value":{"activeCount":1,"pendingCount":0,"errorCount":0,"closedCount":0},"key":"Statistics for all security access reviews","summary":"Statistics for all security access reviews","id":"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/200/content/application~1json/examples/Statistics for all security access reviews"},"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1stats/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/200/content/application~1json/examples/Create a security access review response":{"value":{"id":"sar1lo5X9wmNTFX7x0g4","status":"PENDING","name":"Test SAR","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"],"includedUserProfiles":[{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE"},{"id":"00ucpjbi6JMmDvdN40g5","email":"jane.doe@okta.com","firstName":"Jane","lastName":"Doe","login":"jane.doe@okta.com","status":"ACTIVE"}]}},"createdBy":"00ucfd4IQoH6YBZgA0g4","created":"2025-06-13T00:40:57Z","lastUpdated":"2025-06-13T00:40:57Z","lastUpdatedBy":"00ucfd4IQoH6YBZgA0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4"},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/history"},"userDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/user"},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/accesses"},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/actions"}}},"key":"Create a security access review response","summary":"Create a security access review response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/200/content/application~1json/examples/Create a security access review response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody/content/application~1json/examples/Payload to update a security access review":{"value":{"endTime":"2025-12-31T23:59:59Z","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"]}}},"key":"Payload to update a security access review","summary":"Payload to update a security access review","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/requestBody/content/application~1json/examples/Payload to update a security access review"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/200/content/application~1json/examples/Create a security access review response":{"value":{"id":"sar1lo5X9wmNTFX7x0g4","status":"PENDING","name":"Test SAR","reviewerSettings":{"type":"USER","userSettings":{"includedUserIds":["00ucpjbi6JMmDvdN40g4","00ucpjbi6JMmDvdN40g5"],"includedUserProfiles":[{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE"},{"id":"00ucpjbi6JMmDvdN40g5","email":"jane.doe@okta.com","firstName":"Jane","lastName":"Doe","login":"jane.doe@okta.com","status":"ACTIVE"}]}},"createdBy":"00ucfd4IQoH6YBZgA0g4","created":"2025-06-13T00:40:57Z","lastUpdated":"2025-06-13T00:40:57Z","lastUpdatedBy":"00ucfd4IQoH6YBZgA0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4"},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/history"},"userDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/user"},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/accesses"},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/actions"}}},"key":"Create a security access review response","summary":"Create a security access review response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/200/content/application~1json/examples/Create a security access review response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response":{"value":{"message":"This app's overall priority is: High\nThe reasons why this app was assigned priority of High include:\n1. Usage history (HIGH): The user has not accessed this application in the last 90 days.\n2. Assignment method (HIGH): This user's assignment method differs from 75% of other users who have access to this application.\n"},"key":"Generate a security access review summary response","summary":"Generate a security access review summary response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review":{"value":{"message":"We couldn't generate a summary based on the available data. Please try again later.\n","errors":[{"errorCode":"summary.generator.not.available","errorMsg":"Summary generator is unable to generate summary based on available data. Report this error to customer support."}]},"key":"Failed to generate a summary for a security access review","summary":"Failed to generate a summary for a security access review","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1summary/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/200/content/application~1json/examples/All possible actions for a security access review response":{"value":{"data":[{"actionType":"CLOSE_REVIEW"},{"actionType":"RESTORE_ALL_ACCESS"}]},"key":"All possible actions for a security access review response","summary":"All possible actions for a security access review response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/200/content/application~1json/examples/All possible actions for a security access review response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1actions/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/200/content/application~1json/examples/Target principal of a security access review response":{"value":{"id":"00ucpjbi6JMmDvdN40g4","email":"john.doe@okta.com","firstName":"John","lastName":"Doe","login":"john.doe@okta.com","status":"ACTIVE","department":"Engineering","manager":"Jane Smith","role":"Software Engineer","homeLocation":{"city":"San Francisco","state":"CA","country":"USA"},"lastLoginInfo":{"date":"2025-06-12T15:30:00Z","location":{"city":"San Francisco","state":"CA","country":"USA"},"device":"MacBook Pro","ipAddress":"127.0.0.1"},"oktaAdminRoles":[{"roleId":"00uabc12345XYZ67890","roleName":"Super Admin"}],"createdBy":"00ucfd4IQoH6YBZgA0g4","created":"2025-06-13T00:40:57Z","lastUpdated":"2025-06-13T00:40:57Z","lastUpdatedBy":"00ucfd4IQoH6YBZgA0g4","_links":{"securityAccessReviewDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4"},"history":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/history"},"userDetails":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/user"},"accesses":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/accesses"},"actions":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1lo5X9wmNTFX7x0g4/actions"}}},"key":"Target principal of a security access review response","summary":"Target principal of a security access review response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/200/content/application~1json/examples/Target principal of a security access review response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1principal/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/200/content/application~1json/examples/List access items in a security access review response":{"value":{"data":[{"id":"aim1pmincO6RY9SYC0g4","type":"APPLICATION","name":"App 2 Assigned By Group","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"appInfo":{"id":"0oacmnh7uyRdOpCdg0g4","name":"TEST: Secure Password Store","logoUrl":"http://myorg.okta.com/assets/img/logos/okta-logo-black.e4851b6e6f17df0565a0f2a3f56086f1.png","label":"App 2 Assigned By Group","assignedDate":"2025-06-13T14:23:23Z","assignmentType":"GROUP","applicationUsage":0},"subAccessTypes":["GROUP"]},{"id":"aim1pmjGO1ACFhkxp0g4","type":"APPLICATION","name":"App 1 No Groups","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"appInfo":{"id":"0oacmmurqSIOjNwS90g4","name":"TEST: Secure Password Store","logoUrl":"http://myorg.okta.com/assets/img/logos/okta-logo-black.e4851b6e6f17df0565a0f2a3f56086f1.png","label":"App 1 No Groups","assignedDate":"2025-06-13T14:23:22Z","assignmentType":"INDIVIDUAL","applicationUsage":0}},{"id":"aim1pmkobz1YkJx5N0g4","type":"APPLICATION","name":"App 3 With Entitlements","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"appInfo":{"id":"0oacmo5Hj3n1YOhiK0g4","name":"TEST: Secure Password Store","logoUrl":"http://myorg.okta.com/assets/img/logos/okta-logo-black.e4851b6e6f17df0565a0f2a3f56086f1.png","label":"App 3 With Entitlements","assignedDate":"2025-06-13T14:23:35Z","assignmentType":"INDIVIDUAL","applicationUsage":0,"activeEntitlements":[{"id":"esp1pkp0iVReYgtKU0g4","name":"unbnaovmin","description":"unbnaovmin Description"},{"id":"esp1pldLMJdOb9qI30g4","name":"nozoxxcqiu","description":"nozoxxcqiu Description"},{"id":"esp1plgThoMotdYWU0g4","name":"xpfgzmfhop","description":"xpfgzmfhop Description"}]},"subAccessTypes":["ENTITLEMENT"]}],"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v2/my/security-access-reviews/sar1pmdmaK6ZaAuix0g4/accesses?limit=20&orderBy=priority%20desc"}}},"key":"List access items in a security access review response","summary":"List access items in a security access review response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/200/content/application~1json/examples/List access items in a security access review response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/200/content/application~1json/examples/List of sub-access items response":{"value":{"data":[{"id":"sai1pml8QCT3vGZco0g4","name":"unbnaovmin: value1","type":"ENTITLEMENT","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"entitlementInfo":{"type":"ENTITLEMENT_VALUE","description":"value 1 description","entitlementDescription":"unbnaovmin Description","assignmentType":"INDIVIDUAL","collectionsAssigning":[],"entitlements":[],"governanceLabels":[]}},{"id":"sai1pmmQFzxZreP1L0g4","name":"unbnaovmin: value2","type":"ENTITLEMENT","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"entitlementInfo":{"type":"ENTITLEMENT_VALUE","description":"value 2 description","entitlementDescription":"unbnaovmin Description","assignmentType":"INDIVIDUAL","collectionsAssigning":[],"entitlements":[],"governanceLabels":[]}},{"id":"sai1pmngWq0n4IGFi0g4","name":"test bundleaotsw","type":"ENTITLEMENT","severity":"LOW","supportedActions":["REVOKE_ACCESS"],"entitlementInfo":{"type":"ENTITLEMENT_BUNDLE","description":"test bundle ...","assignmentType":"ACCESS_REQUEST","collectionsAssigning":[],"entitlements":[{"id":"esp1pldLMJdOb9qI30g4","name":"nozoxxcqiu","description":"nozoxxcqiu Description"},{"id":"esp1plgThoMotdYWU0g4","name":"xpfgzmfhop","description":"xpfgzmfhop Description"}],"governanceLabels":[]}}],"_links":{"self":{"href":"https://myorg.okta1.com/governance/api/v2/my/security-access-reviews/sar1pmdmaK6ZaAuix0g4/accesses/aim1pmkobz1YkJx5N0g4/sub-accesses?limit=20&orderBy=priority%20desc","hints":{}}}},"key":"List of sub-access items response","summary":"List of sub-access items response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/200/content/application~1json/examples/List of sub-access items response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewAccessId}~1sub-accesses/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/200/content/application~1json/examples/Response for access item anomolies":{"value":{"data":[{"type":"USAGE_HISTORY","severity":"LOW","subtext":{"message":"The user was assigned the app recently, {0}","args":[{"value":"2025-06-13T15:23:59Z","type":"RELATIVE_DATE_TO_NOW"}]}},{"type":"ASSIGNMENT_METHOD","severity":"LOW","subtext":{"message":"The user was assigned to the group directly, aligning with {0}% of users who were assigned the same way","args":[{"value":"100","type":"NUMBER"}]}},{"type":"PAST_GOVERNANCE_DECISIONS","severity":"LOW","subtext":{"message":"No data found. The assignment has no past governance decisions"}}]},"key":"Response for access item anomolies","summary":"Response for access item anomolies","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/200/content/application~1json/examples/Response for access item anomolies"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1anomalies/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response":{"value":{"message":"This app's overall priority is: High\nThe reasons why this app was assigned priority of High include:\n1. Usage history (HIGH): The user has not accessed this application in the last 90 days.\n2. Assignment method (HIGH): This user's assignment method differs from 75% of other users who have access to this application.\n"},"key":"Generate a security access review summary response","summary":"Generate a security access review summary response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Generate a security access review summary response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review":{"value":{"message":"We couldn't generate a summary based on the available data. Please try again later.\n","errors":[{"errorCode":"summary.generator.not.available","errorMsg":"Summary generator is unable to generate summary based on available data. Report this error to customer support."}]},"key":"Failed to generate a summary for a security access review","summary":"Failed to generate a summary for a security access review","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/200/content/application~1json/examples/Failed to generate a summary for a security access review"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1summary/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1accesses~1{securityAccessReviewTargetId}~1actions/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/200/content/application~1json/examples/History of a security access review response":{"value":{"data":[{"id":"srh1pmhpjmJ6Oyzzx0g4","systemGenerated":true,"timestamp":"2025-06-13T14:23:35Z","message":"created Test SAR","principalProfile":{"id":"00ucmjraRsXXFRRSK0g4","email":"admin@zwqzmjg4yzetngnimi00nznhlwe2ytmtnzk5ogjjywrkmjyz.com","firstName":"Add-Min","lastName":"O'Cloudy Tud","login":"admin@zwqzmjg4yzetngnimi00nznhlwe2ytmtnzk5ogjjywrkmjyz.com","status":"ACTIVE"}}],"_links":{"self":{"href":"https://myorg.okta1.com/governance/api/v2/my/security-access-reviews/sar1pmdmaK6ZaAuix0g4/history?limit=20","hints":{}}}},"key":"History of a security access review response","summary":"History of a security access review response","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/200/content/application~1json/examples/History of a security access review response"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1history/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1security-access-reviews~1{securityAccessReviewId}~1comment/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates":{"value":{"delegates":{"enduser":{"permissions":["WRITE"]}}},"key":"All end users have write access and can edit their delegates","summary":"All end users have write access and can edit their delegates","id":"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates"},"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates":{"value":{"delegates":{"enduser":{"permissions":["READ"]}}},"key":"All end users have read-only access and can view their delegates","summary":"All end users have read-only access and can view their delegates","id":"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates"},"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations":{"value":{"delegates":{"enduser":{"permissions":["READ"]}},"escalations":{"accessRequests":{"endUserCanEscalate":true}}},"key":"Governance settings for delegates and access request escalations","summary":"Governance settings for delegates and access request escalations","id":"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations"},"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate":{"value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"}]}}},"key":"End users can only assign their manager as a delegate","summary":"End users can only assign their manager as a delegate","id":"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate"},"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates":{"value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"},{"type":"PEERS"}]}}},"key":"End users can assign their manager or peers as delegates","summary":"End users can assign their manager or peers as delegates","id":"paths/~1governance~1api~1v1~1settings/get/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"},"paths/~1governance~1api~1v1~1settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1settings/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have write access and can edit their delegates":{"value":{"delegates":{"enduser":{"permissions":["WRITE"]}}},"key":"All end users have write access and can edit their delegates","summary":"All end users have write access and can edit their delegates","id":"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have write access and can edit their delegates"},"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have read-only access and can view their delegates":{"value":{"delegates":{"enduser":{"permissions":["READ"]}}},"key":"All end users have read-only access and can view their delegates","summary":"All end users have read-only access and can view their delegates","id":"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/All end users have read-only access and can view their delegates"},"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/Governance settings for delegates and access request escalations":{"value":{"delegates":{"enduser":{"permissions":["READ"]}},"escalations":{"accessRequests":{"endUserCanEscalate":true}}},"key":"Governance settings for delegates and access request escalations","summary":"Governance settings for delegates and access request escalations","id":"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/Governance settings for delegates and access request escalations"},"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can only assign their manager as a delegate":{"value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"}]}}},"key":"End users can only assign their manager as a delegate","summary":"End users can only assign their manager as a delegate","id":"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can only assign their manager as a delegate"},"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can assign their manager or peers as delegates":{"value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"},{"type":"PEERS"}]}}},"key":"End users can assign their manager or peers as delegates","summary":"End users can assign their manager or peers as delegates","id":"paths/~1governance~1api~1v1~1settings/patch/requestBody/content/application~1json/examples/End users can assign their manager or peers as delegates"},"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates":{"value":{"delegates":{"enduser":{"permissions":["WRITE"]}}},"key":"All end users have write access and can edit their delegates","summary":"All end users have write access and can edit their delegates","id":"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have write access and can edit their delegates"},"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates":{"value":{"delegates":{"enduser":{"permissions":["READ"]}}},"key":"All end users have read-only access and can view their delegates","summary":"All end users have read-only access and can view their delegates","id":"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/All end users have read-only access and can view their delegates"},"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations":{"value":{"delegates":{"enduser":{"permissions":["READ"]}},"escalations":{"accessRequests":{"endUserCanEscalate":true}}},"key":"Governance settings for delegates and access request escalations","summary":"Governance settings for delegates and access request escalations","id":"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/Governance settings for delegates and access request escalations"},"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate":{"value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"}]}}},"key":"End users can only assign their manager as a delegate","summary":"End users can only assign their manager as a delegate","id":"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can only assign their manager as a delegate"},"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates":{"value":{"delegates":{"enduser":{"permissions":["WRITE"],"onlyFor":[{"type":"MANAGER"},{"type":"PEERS"}]}}},"key":"End users can assign their manager or peers as delegates","summary":"End users can assign their manager or peers as delegates","id":"paths/~1governance~1api~1v1~1settings/patch/responses/200/content/application~1json/examples/End users can assign their manager or peers as delegates"},"paths/~1governance~1api~1v1~1settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1settings/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations in progress":{"value":{"data":[{"id":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","status":"IN_PROGRESS"}]},"key":"List integrations in progress","summary":"List integrations in progress","id":"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations in progress"},"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations connected":{"value":{"data":[{"id":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","status":"CONNECTED"}]},"key":"List integrations connected","summary":"List integrations connected","id":"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations connected"},"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations failed":{"value":{"data":[{"id":"goi5a4b3c2d1e9f8g7h6","type":"SLACK","status":"FAILED"}]},"key":"List integrations failed","summary":"List integrations failed","id":"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/200/content/application~1json/examples/List integrations failed"},"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody/content/application~1json/examples/Create Slack integration":{"value":{"type":"SLACK"},"key":"Create Slack integration","summary":"Create Slack integration","id":"paths/~1governance~1api~1v1~1settings~1integrations/post/requestBody/content/application~1json/examples/Create Slack integration"},"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/201/content/application~1json/examples/Slack integration in progress":{"value":{"id":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","status":"IN_PROGRESS","_links":{"authUrl":{"href":"https://slack.com/oauth/v2/authorize?client_id=XXXX&scope=channels:read,chat:write,commands,users:read&state=XXXX"}}},"key":"Slack integration in progress","summary":"Slack integration in progress","id":"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/201/content/application~1json/examples/Slack integration in progress"},"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations/post/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1integrations~1{integrationId}/delete/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/get/responses/200/content/application~1json/examples/Notifications are enabled for all supported integrations":{"value":{"integrations":{"settings":[{"integrationId":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","notifications":{"enabled":true}}]}},"key":"Notifications are enabled for all supported integrations","summary":"Notifications are enabled for all supported integrations","id":"paths/~1governance~1api~1v1~1settings~1certification/get/responses/200/content/application~1json/examples/Notifications are enabled for all supported integrations"},"paths/~1governance~1api~1v1~1settings~1certification/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1settings~1certification/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1settings~1certification/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody/content/application~1json/examples/Certification notification settings for the org":{"value":{"integrations":{"settings":[{"integrationId":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","notifications":{"enabled":true}}]}},"key":"Certification notification settings for the org","summary":"Certification notification settings for the org","id":"paths/~1governance~1api~1v1~1settings~1certification/patch/requestBody/content/application~1json/examples/Certification notification settings for the org"},"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/200/content/application~1json/examples/Certification notification settings for the org":{"value":{"integrations":{"settings":[{"integrationId":"goi5a4b3c2d1e9f8g7h5","type":"SLACK","notifications":{"enabled":true}}]}},"key":"Certification notification settings for the org","summary":"Certification notification settings for the org","id":"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/200/content/application~1json/examples/Certification notification settings for the org"},"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1settings~1certification/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature":{"value":{"status":"OPTED_IN"},"key":"Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature","summary":"Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature","description":"Updates entitlement settings to opt in the resource to entitlement management feature","id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt in the resource |tooltip| Updates entitlement settings to opt in the resource to entitlement management feature"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management":{"value":{"status":"OPTED_OUT"},"key":"Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management","summary":"Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management","description":"Updates entitlement settings to opt the resource out of entitlement management","id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/requestBody/content/application~1json/examples/Opt out the resource |tooltip| Updates entitlement settings to opt the resource out of entitlement management"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/patch/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource":{"value":{"status":"OPTED_OUT"},"key":"Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource","summary":"Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource","description":"Entitlement management disabled for a resource","id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management disabled for a resource |tooltip| Entitlement management disabled for a resource"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource":{"value":{"status":"OPTED_IN"},"key":"Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource","summary":"Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource","description":"Entitlement management enabled for a resource","id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/200/content/application~1json/examples/Entitlement management enabled for a resource |tooltip| Entitlement management enabled for a resource"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/404/content/application~1json/example":{"value":{"errorCode":"E0000007","errorSummary":"Resource not found exception","errorLink":"E0000007","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/404/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v2~1resources~1{resourceOrn}~1entitlement-settings/get/responses/500/content/application~1json/example"},"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Operation in RUNNING status":{"value":{"id":"cpa4r1gtPOqBal07j0g5","type":"collection:principal:assignment","status":"RUNNING","created":"2026-01-09T01:25:04.000Z","started":"2026-01-09T01:25:05.208Z","completed":null,"timeElapsedInSeconds":1,"_links":{"self":{"href":"https://myorg.okta.com/governance/api/v1/operations/cpa4r1gtPOqBal07j0g5"}}},"key":"Operation in RUNNING status","summary":"Operation in RUNNING status","id":"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/200/content/application~1json/examples/Operation in RUNNING status"},"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error.":{"value":{"errorCode":"E0000004","errorSummary":"Authentication failed.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"key":"When the API token is invalid, the response body contains an error.","summary":"When the API token is invalid, the response body contains an error.","id":"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/401/content/application~1json/examples/When the API token is invalid, the response body contains an error."},"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/example":{"value":{"errorCode":"E0000004","errorSummary":"You don't have permission to perform the requested action.","errorLink":"E0000004","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/403/content/application~1json/example"},"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/example":{"value":{"errorCode":"E0000047","errorSummary":"The API call exceeded the rate limit due to too many requests.","errorLink":"E0000047","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/429/content/application~1json/example"},"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/500/content/application~1json/example":{"value":{"errorCode":"E0000009","errorSummary":"Internal Server Error","errorLink":"E0000009","errorId":"oaeWCGz73hpRCG75VHP6-RRXw","errorCauses":[]},"id":"paths/~1governance~1api~1v1~1operations~1{operationId}/get/responses/500/content/application~1json/example"}},"securitySchemeStore":{"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 "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"access_token"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" as the value of the Authorization header: "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"Authorization: Bearer {access_token}"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":". See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://developer.okta.com/docs/guides/implement-oauth-for-okta-serviceapp/main/#make-a-request"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Make a request"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"flows":{"authorizationCode":{"authorizationUrl":"/oauth2/v1/authorize","tokenUrl":"/oauth2/v1/token","scopes":{"okta.governance.accessCertifications.manage":"Allows the app to create and manage Access Certification Campaigns","okta.governance.accessCertifications.read":"Allows the app to read information about Access Certification Campaigns and Reviews in your Okta org","okta.governance.accessRequests.manage":"Allows the app to create and manage V1 Access Requests, Request Types, and Teams","okta.governance.accessRequests.read":"Allows the app to read information about V1 Access Requests, Request Types, and Teams in your Okta org","okta.governance.entitlements.read":"Allows the app to read information about Entitlements, Entitlement bundles, and Grants","okta.governance.entitlements.manage":"Allows the app to create and manage Entitlements, Entitlement bundles, and Grants","okta.accessRequests.catalog.read":"Allows the app to read information about Access Request Catalogs in your Okta org","okta.accessRequests.condition.manage":"Allows the app to create and manage Conditions for the Access Request Resource Catalog","okta.accessRequests.condition.read":"Allows the app to read information about Conditions for the Access Request Resource Catalog","okta.accessRequests.request.manage":"Allows the app to create and manage V2 Access Requests through the Access Request Resource Catalog","okta.accessRequests.request.read":"Allows the app to read information about V2 Access Requests created through the Access Requests Resource Catalog","okta.governance.collections.manage":"Allows the app to create and manage collections","okta.governance.collections.read":"Allows the app to read information about collections in your Okta org","okta.governance.operations.read":"Allows the app to read information about asynchronous operations in your Okta org","okta.governance.riskRule.manage":"Allows the app to create and manage rules","okta.governance.riskRule.read":"Allows the app to read information about rules in your Okta org","okta.governance.resourceOwner.manage":"Allows the app to create and manage resource owners","okta.governance.resourceOwner.read":"Allows the app to read information about resource owners in your Okta org","okta.governance.labels.manage":"Allows the user to create and manage labels","okta.governance.labels.read":"Allows the user to read information about labels in your Okta org","okta.governance.securityAccessReviews.admin.manage":"Allows the admin app to create and manage security access reviews","okta.governance.securityAccessReviews.admin.read":"Allows the admin app to read information about security access reviews","okta.governance.securityAccessReviews.endUser.manage":"Allows the end-user app to create and manage security access reviews","okta.governance.securityAccessReviews.endUser.read":"Allows the end-user app to read information about security access reviews","okta.governance.principalSettings.manage":"Allows the app to create and manage governance settings for any user in your Okta org","okta.governance.principalSettings.read":"Allows the app to read information about governance settings for any user in your Okta org","okta.governance.settings.manage":"Allows the app to create and manage governance settings for your Okta org","okta.governance.settings.read":"Allows the app to read information about governance settings for your Okta org","okta.governance.delegates.read":"Allows the app to read information about delegates in your Okta org","okta.governance.reviewer.read":"Allows the end user to read information about access certification reviews assigned to them","okta.governance.reviewer.manage":"Allows the end user to manage access certification reviews assigned to them","okta.accessRequests.tasks.manage":"Allows the user to manage tasks for access requests in your Okta org","okta.accessRequests.tasks.read":"Allows the user to read information about tasks for access requests in your Okta org"}}}},"ApiKey":{"id":"ApiKey","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":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"."},"children":[]}]}]}],"in":"header","paramName":"Authorization"}},"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/iga/openapi/governance-production-reference.json?download"},{"url":"/docs/api/_bundle/iga/openapi/governance-production-reference.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Okta Governance API","description":"Allows customers to easily access the Okta API"}},"baseSlug":"/iga/openapi/governance-production-reference","routesMapping":{}}