{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Okta Identity Governance API","description":"Okta Developer API Reference","siteUrl":"https://developer-okta.login.adsbillinghub.com","keywords":"okta, api reference docs","lang":"en-US"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"okta-identity-governance-api","__idx":0},"children":["Okta Identity Governance API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Okta Identity Governance is a SaaS-delivered, converged and intuitive Identity and Access management platform. Use it to simplify and manage your identity and access lifecycles across multiple systems and improve the overall security of your company."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Okta Identity Governance builds upon the existing Okta Life Cycle Management products, such as Provisioning and Workflows, which help enterprises simplify access fulfillment and entitlement tasks throughout a user’s identity lifecycle."]},{"$$mdtype":"Tag","name":"blockquote","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Note:"]}," You can use the Okta Identity Governance APIs if you're subscribed to ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://www-okta.login.adsbillinghub.com/products/identity-governance/"},"children":["Okta Identity Governance"]},". The APIs that are in ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"https://developer-okta.login.adsbillinghub.com/docs/api/openapi/okta-management/guides/release-lifecycle/#beta"},"children":["Beta"]}," are available on both the Preview and Production environments. Contact your Customer Success Manager or Account Executive for more information."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"domain-model","__idx":1},"children":["Domain model"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"nouns","__idx":2},"children":["Nouns"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n RESOURCE }|--|| RESOURCE-PROVIDER: \"provided by\"\n CAMPAIGNS ||--|{ REVIEWS : generate\n \"REQUEST-CONDITIONS\" ||--|| \"REQUEST-SEQUENCES\" : \"use\"\n \"REQUEST-CONDITIONS\" ||--|| \"CATALOG-ENTRIES\" : \"generate\"\n \"CATALOG-ENTRIES\" ||--|{ \"REQUESTS\" : \"allows\"\n","diagramHtml":"

provided by

generate

use

generate

allows

RESOURCE

RESOURCE-PROVIDER

CAMPAIGNS

REVIEWS

REQUEST-CONDITIONS

REQUEST-SEQUENCES

CATALOG-ENTRIES

REQUESTS

","diagramHtmlDark":"

provided by

generate

use

generate

allows

RESOURCE

RESOURCE-PROVIDER

CAMPAIGNS

REVIEWS

REQUEST-CONDITIONS

REQUEST-SEQUENCES

CATALOG-ENTRIES

REQUESTS

"},"children":["erDiagram\n RESOURCE }|--|| RESOURCE-PROVIDER: \"provided by\"\n CAMPAIGNS ||--|{ REVIEWS : generate\n \"REQUEST-CONDITIONS\" ||--|| \"REQUEST-SEQUENCES\" : \"use\"\n \"REQUEST-CONDITIONS\" ||--|| \"CATALOG-ENTRIES\" : \"generate\"\n \"CATALOG-ENTRIES\" ||--|{ \"REQUESTS\" : \"allows\"\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"noun-api-reference","__idx":3},"children":["Noun API reference"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-reference/campaigns"},"children":["Campaigns"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-reference/reviews"},"children":["Reviews"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v2-reference/request-conditions"},"children":["Request conditions"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v2-reference/request-sequences"},"children":["Request sequences"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v2-reference/request-settings"},"children":["Request settings"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"relationships","__idx":4},"children":["Relationships"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n RESOURCE ||--o{ GRANT : \"has many\"\n RESOURCE ||--o{ ENTITLEMENT-BUNDLE : \"has many\"\n RESOURCE ||--o{ ENTITLEMENT : \"has many\"\n RESOURCE ||--o{ REVIEW : \"has many\"\n RESOURCE ||--o{ \"REQUEST (v1)\": \"has many\"\n RESOURCE }|--o{ CAMPAIGN : \"referenced by\"\n RESOURCE }|--o{ \"REQUEST-CONDITIONS\": \"referenced by\"\n","diagramHtml":"

has many

has many

has many

has many

has many

referenced by

referenced by

RESOURCE

GRANT

ENTITLEMENT-BUNDLE

ENTITLEMENT

REVIEW

REQUEST (v1)

CAMPAIGN

REQUEST-CONDITIONS

","diagramHtmlDark":"

has many

has many

has many

has many

has many

referenced by

referenced by

RESOURCE

GRANT

ENTITLEMENT-BUNDLE

ENTITLEMENT

REVIEW

REQUEST (v1)

CAMPAIGN

REQUEST-CONDITIONS

"},"children":["erDiagram\n RESOURCE ||--o{ GRANT : \"has many\"\n RESOURCE ||--o{ ENTITLEMENT-BUNDLE : \"has many\"\n RESOURCE ||--o{ ENTITLEMENT : \"has many\"\n RESOURCE ||--o{ REVIEW : \"has many\"\n RESOURCE ||--o{ \"REQUEST (v1)\": \"has many\"\n RESOURCE }|--o{ CAMPAIGN : \"referenced by\"\n RESOURCE }|--o{ \"REQUEST-CONDITIONS\": \"referenced by\"\n"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n CAMPAIGN ||--|| STATUS : has\n CAMPAIGN ||--o{ REVIEWS : generates\n CAMPAIGN {\n setting remediationSettings\n setting resourceSettings\n setting reviewerSettings\n setting scheduleSettings\n setting notificationSettings\n setting principalScopeSettings\n }\n","diagramHtml":"

has

generates

CAMPAIGN

setting

remediationSettings

setting

resourceSettings

setting

reviewerSettings

setting

scheduleSettings

setting

notificationSettings

setting

principalScopeSettings

STATUS

REVIEWS

","diagramHtmlDark":"

has

generates

CAMPAIGN

setting

remediationSettings

setting

resourceSettings

setting

reviewerSettings

setting

scheduleSettings

setting

notificationSettings

setting

principalScopeSettings

STATUS

REVIEWS

"},"children":["erDiagram\n CAMPAIGN ||--|| STATUS : has\n CAMPAIGN ||--o{ REVIEWS : generates\n CAMPAIGN {\n setting remediationSettings\n setting resourceSettings\n setting reviewerSettings\n setting scheduleSettings\n setting notificationSettings\n setting principalScopeSettings\n }\n"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n REVIEW ||--|| CAMPAIGN : \"created by\"\n REVIEW ||..|| RESOURCE : has\n REVIEW ||..|| PRINCIPAL : has\n REVIEW ||--|| REVIEWER : has\n REVIEW ||--o| DECISION : \"made by reviewer\"\n REVIEW ||--|| REMEDIATION : has\n REVIEW ||--|{ HISTORY : has\n","diagramHtml":"

created by

has

has

has

made by reviewer

has

has

REVIEW

CAMPAIGN

RESOURCE

PRINCIPAL

REVIEWER

DECISION

REMEDIATION

HISTORY

","diagramHtmlDark":"

created by

has

has

has

made by reviewer

has

has

REVIEW

CAMPAIGN

RESOURCE

PRINCIPAL

REVIEWER

DECISION

REMEDIATION

HISTORY

"},"children":["erDiagram\n REVIEW ||--|| CAMPAIGN : \"created by\"\n REVIEW ||..|| RESOURCE : has\n REVIEW ||..|| PRINCIPAL : has\n REVIEW ||--|| REVIEWER : has\n REVIEW ||--o| DECISION : \"made by reviewer\"\n REVIEW ||--|| REMEDIATION : has\n REVIEW ||--|{ HISTORY : has\n"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n REQUEST-CONDITION ||--|{ CATALOG-ENTRY : \"generates\"\n REQUEST-CONDITION {\n settings resourceSettings\n settings requesterSettings\n settings accessSettings\n settings approvalSettings\n }\n","diagramHtml":"

generates

REQUEST-CONDITION

settings

resourceSettings

settings

requesterSettings

settings

accessSettings

settings

approvalSettings

CATALOG-ENTRY

","diagramHtmlDark":"

generates

REQUEST-CONDITION

settings

resourceSettings

settings

requesterSettings

settings

accessSettings

settings

approvalSettings

CATALOG-ENTRY

"},"children":["erDiagram\n REQUEST-CONDITION ||--|{ CATALOG-ENTRY : \"generates\"\n REQUEST-CONDITION {\n settings resourceSettings\n settings requesterSettings\n settings accessSettings\n settings approvalSettings\n }\n"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n ENTRY ||--|| RESOURCE : \"represents one\"\n ENTRY ||--o{ CHILD-ENTRY : \"could have children\"\n CHILD-ENTRY ||--|| ACCESS-SCOPE : \"related to\"\n CHILD-ENTRY ||--|| RESOURCE : \"related to\"\n ACCESS-SCOPE ||--|| GROUP : \"via\"\n ACCESS-SCOPE ||--|| ENTITLEMENT-BUNDLE : \"via\"\n ACCESS-SCOPE ||--|| ENTITLEMENT-VALUE : \"via\"\n","diagramHtml":"

represents one

could have children

related to

related to

via

via

via

ENTRY

RESOURCE

CHILD-ENTRY

ACCESS-SCOPE

GROUP

ENTITLEMENT-BUNDLE

ENTITLEMENT-VALUE

","diagramHtmlDark":"

represents one

could have children

related to

related to

via

via

via

ENTRY

RESOURCE

CHILD-ENTRY

ACCESS-SCOPE

GROUP

ENTITLEMENT-BUNDLE

ENTITLEMENT-VALUE

"},"children":["erDiagram\n ENTRY ||--|| RESOURCE : \"represents one\"\n ENTRY ||--o{ CHILD-ENTRY : \"could have children\"\n CHILD-ENTRY ||--|| ACCESS-SCOPE : \"related to\"\n CHILD-ENTRY ||--|| RESOURCE : \"related to\"\n ACCESS-SCOPE ||--|| GROUP : \"via\"\n ACCESS-SCOPE ||--|| ENTITLEMENT-BUNDLE : \"via\"\n ACCESS-SCOPE ||--|| ENTITLEMENT-VALUE : \"via\"\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"entitlement-management","__idx":5},"children":["Entitlement management"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"resource---an-object-that-may-be-governed","__idx":6},"children":["Resource - \"An object that may be governed\""]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n RESOURCE ||--|{ ENTITLEMENTS : \"when resourceType = APP\"\n RESOURCE {\n string resourceId \"0oa...,00g...,00e...\"\n enum resourceType \"APP, GROUP\"\n string name \"Salesforce instance, Engineers, Salesforce Admin\"\n string description \"This instance..., This group...\"\n }\n","diagramHtml":"

when resourceType = APP

RESOURCE

string

resourceId

0oa...,00g...,00e...

enum

resourceType

APP, GROUP

string

name

Salesforce instance, Engineers, Salesforce Admin

string

description

This instance..., This group...

ENTITLEMENTS

","diagramHtmlDark":"

when resourceType = APP

RESOURCE

string

resourceId

0oa...,00g...,00e...

enum

resourceType

APP, GROUP

string

name

Salesforce instance, Engineers, Salesforce Admin

string

description

This instance..., This group...

ENTITLEMENTS

"},"children":["erDiagram\n RESOURCE ||--|{ ENTITLEMENTS : \"when resourceType = APP\"\n RESOURCE {\n string resourceId \"0oa...,00g...,00e...\"\n enum resourceType \"APP, GROUP\"\n string name \"Salesforce instance, Engineers, Salesforce Admin\"\n string description \"This instance..., This group...\"\n }\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"entitlements---a-collection-of-entitlement-with-corresponding-allowed-values","__idx":7},"children":["Entitlements - A collection of entitlement with corresponding allowed values"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n ENTITLEMENT ||--|{ ENTITLEMENT-VALUE : \"has all\"\n ENTITLEMENT ||--|| RESOURCE : \"belongs to parent\"\n ENTITLEMENT {\n string id\n string name\n string displayName\n string description\n boolean multiValue\n boolean required\n }\n ENTITLEMENT-VALUE {\n string id\n string displayName\n string value\n string description\n }\n","diagramHtml":"

has all

belongs to parent

ENTITLEMENT

string

id

string

name

string

displayName

string

description

boolean

multiValue

boolean

required

ENTITLEMENT-VALUE

string

id

string

displayName

string

value

string

description

RESOURCE

","diagramHtmlDark":"

has all

belongs to parent

ENTITLEMENT

string

id

string

name

string

displayName

string

description

boolean

multiValue

boolean

required

ENTITLEMENT-VALUE

string

id

string

displayName

string

value

string

description

RESOURCE

"},"children":["erDiagram\n ENTITLEMENT ||--|{ ENTITLEMENT-VALUE : \"has all\"\n ENTITLEMENT ||--|| RESOURCE : \"belongs to parent\"\n ENTITLEMENT {\n string id\n string name\n string displayName\n string description\n boolean multiValue\n boolean required\n }\n ENTITLEMENT-VALUE {\n string id\n string displayName\n string value\n string description\n }\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"entitlement-bundle","__idx":8},"children":["Entitlement Bundle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n ENTITLEMENT-BUNDLE ||--|{ ENTITLEMENTS : \"has some\"\n ENTITLEMENT-BUNDLE }|--|| RESOURCE : \"belongs to\"\n ENTITLEMENTS ||--|{ ENTITLEMENT-VALUE : \"with selected\"\n ENTITLEMENTS }|--|| RESOURCE : \"belongs to\"\n\n ENTITLEMENT-BUNDLE {\n string name\n string description\n }\n","diagramHtml":"

has some

belongs to

with selected

belongs to

ENTITLEMENT-BUNDLE

string

name

string

description

ENTITLEMENTS

RESOURCE

ENTITLEMENT-VALUE

","diagramHtmlDark":"

has some

belongs to

with selected

belongs to

ENTITLEMENT-BUNDLE

string

name

string

description

ENTITLEMENTS

RESOURCE

ENTITLEMENT-VALUE

"},"children":["erDiagram\n ENTITLEMENT-BUNDLE ||--|{ ENTITLEMENTS : \"has some\"\n ENTITLEMENT-BUNDLE }|--|| RESOURCE : \"belongs to\"\n ENTITLEMENTS ||--|{ ENTITLEMENT-VALUE : \"with selected\"\n ENTITLEMENTS }|--|| RESOURCE : \"belongs to\"\n\n ENTITLEMENT-BUNDLE {\n string name\n string description\n }\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"collection---a-group-of-resources-and-associated-entitlements","__idx":9},"children":["Collection - A group of resources and associated entitlements"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n COLLECTION ||--|{ RESOURCE : \"contains\"\n COLLECTION ||--|{ ENTITLEMENT : \"contains\"\n ENTITLEMENT ||--|| RESOURCE : \"belongs to\"\n COLLECTION {\n string name\n string description\n }\n","diagramHtml":"

contains

contains

belongs to

COLLECTION

string

name

string

description

RESOURCE

ENTITLEMENT

","diagramHtmlDark":"

contains

contains

belongs to

COLLECTION

string

name

string

description

RESOURCE

ENTITLEMENT

"},"children":["erDiagram\n COLLECTION ||--|{ RESOURCE : \"contains\"\n COLLECTION ||--|{ ENTITLEMENT : \"contains\"\n ENTITLEMENT ||--|| RESOURCE : \"belongs to\"\n COLLECTION {\n string name\n string description\n }\n"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n COLLECTION-ASSIGNMENT ||--|| COLLECTION : \"for a target\"\n COLLECTION-ASSIGNMENT ||--|| PRINCIPAL : \"assigned to\"\n COLLECTION-ASSIGNMENT ||--|{ GRANTS : \"generates one or more\"\n","diagramHtml":"

for a target

assigned to

generates one or more

COLLECTION-ASSIGNMENT

COLLECTION

PRINCIPAL

GRANTS

","diagramHtmlDark":"

for a target

assigned to

generates one or more

COLLECTION-ASSIGNMENT

COLLECTION

PRINCIPAL

GRANTS

"},"children":["erDiagram\n COLLECTION-ASSIGNMENT ||--|| COLLECTION : \"for a target\"\n COLLECTION-ASSIGNMENT ||--|| PRINCIPAL : \"assigned to\"\n COLLECTION-ASSIGNMENT ||--|{ GRANTS : \"generates one or more\"\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"grant","__idx":10},"children":["Grant"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n GRANT ||--|| TARGET-PRINCIPAL : \"granted to\"\n GRANT ||--|| RESOURCE : \"for a target\"\n RESOURCE ||--o{ ENTITLEMENTS : \"may have\"\n GRANT ||--o{ ENTITLEMENT-BUNDLE : \"may have\"\n GRANT {\n enum grantType\n enum action\n settings scheduleSettings\n enum status\n }\n RESOURCE {\n string type\n string externalId\n }\n","diagramHtml":"

granted to

for a target

may have

may have

GRANT

enum

grantType

enum

action

settings

scheduleSettings

enum

status

TARGET-PRINCIPAL

RESOURCE

string

type

string

externalId

ENTITLEMENTS

ENTITLEMENT-BUNDLE

","diagramHtmlDark":"

granted to

for a target

may have

may have

GRANT

enum

grantType

enum

action

settings

scheduleSettings

enum

status

TARGET-PRINCIPAL

RESOURCE

string

type

string

externalId

ENTITLEMENTS

ENTITLEMENT-BUNDLE

"},"children":["erDiagram\n GRANT ||--|| TARGET-PRINCIPAL : \"granted to\"\n GRANT ||--|| RESOURCE : \"for a target\"\n RESOURCE ||--o{ ENTITLEMENTS : \"may have\"\n GRANT ||--o{ ENTITLEMENT-BUNDLE : \"may have\"\n GRANT {\n enum grantType\n enum action\n settings scheduleSettings\n enum status\n }\n RESOURCE {\n string type\n string externalId\n }\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"principal-entitlement--assigned-entitlement-with-values-for-a-principal","__idx":11},"children":["Principal Entitlement : Assigned entitlement with values for a Principal"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n PRINCIPAL-ENTITLEMENT ||--|{ ENTITLEMENT-VALUE : \"with\"\n PRINCIPAL-ENTITLEMENT ||--|| RESOURCE : \"belongs to parent\"\n PRINCIPAL-ENTITLEMENT ||--|| TARGET-PRINCIPAL : \"assigned to\"\n PRINCIPAL-ENTITLEMENT {\n string id\n string name\n string displayName\n string description\n boolean multiValue\n boolean required\n }\n ENTITLEMENT-VALUE {\n string id\n string displayName\n string value\n string description\n }\n","diagramHtml":"

with

belongs to parent

assigned to

PRINCIPAL-ENTITLEMENT

string

id

string

name

string

displayName

string

description

boolean

multiValue

boolean

required

ENTITLEMENT-VALUE

string

id

string

displayName

string

value

string

description

RESOURCE

TARGET-PRINCIPAL

","diagramHtmlDark":"

with

belongs to parent

assigned to

PRINCIPAL-ENTITLEMENT

string

id

string

name

string

displayName

string

description

boolean

multiValue

boolean

required

ENTITLEMENT-VALUE

string

id

string

displayName

string

value

string

description

RESOURCE

TARGET-PRINCIPAL

"},"children":["erDiagram\n PRINCIPAL-ENTITLEMENT ||--|{ ENTITLEMENT-VALUE : \"with\"\n PRINCIPAL-ENTITLEMENT ||--|| RESOURCE : \"belongs to parent\"\n PRINCIPAL-ENTITLEMENT ||--|| TARGET-PRINCIPAL : \"assigned to\"\n PRINCIPAL-ENTITLEMENT {\n string id\n string name\n string displayName\n string description\n boolean multiValue\n boolean required\n }\n ENTITLEMENT-VALUE {\n string id\n string displayName\n string value\n string description\n }\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"governance-object-lifecycles","__idx":12},"children":["Governance object lifecycles"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Governance objects have lifecycles that are driven by system and user interactions."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When using governance APIs, it is important to understand the potential status values of objects, and how they transition from one lifecycle state to another."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"campaign","__idx":13},"children":["Campaign"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"campaign-status-lifecycle","__idx":14},"children":["Campaign status lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n SCHEDULED -- \"/launch\" --> LAUNCHING\n SCHEDULED -- \"background job\" --> LAUNCHING\n LAUNCHING -- \"background job\" --> ACTIVE\n LAUNCHING -- \"background job\" --> ERROR\n ACTIVE -- \"/end\" --> COMPLETED\n COMPLETED -- \"background purger\" --> 404[\"404 Not found\"]\n ERROR -- \"/delete\" --> 404[\"404 Not found\"]\n SCHEDULED -- \"/delete\" --> 404[\"404 Not found\"]\n","diagramHtml":"

/launch

background job

background job

background job

/end

background purger

/delete

/delete

404 Not found

SCHEDULED

LAUNCHING

ACTIVE

ERROR

COMPLETED

","diagramHtmlDark":"

/launch

background job

background job

background job

/end

background purger

/delete

/delete

404 Not found

SCHEDULED

LAUNCHING

ACTIVE

ERROR

COMPLETED

"},"children":["flowchart TD\n SCHEDULED -- \"/launch\" --> LAUNCHING\n SCHEDULED -- \"background job\" --> LAUNCHING\n LAUNCHING -- \"background job\" --> ACTIVE\n LAUNCHING -- \"background job\" --> ERROR\n ACTIVE -- \"/end\" --> COMPLETED\n COMPLETED -- \"background purger\" --> 404[\"404 Not found\"]\n ERROR -- \"/delete\" --> 404[\"404 Not found\"]\n SCHEDULED -- \"/delete\" --> 404[\"404 Not found\"]\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following lifecycle operations are available on single Request Types."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-reference/campaigns/createcampaign"},"children":["Add"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-reference/campaigns/launchcampaign"},"children":["Launch"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-reference/campaigns/endcampaign"},"children":["End"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-reference/campaigns/deletecampaign"},"children":["Delete"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-condition","__idx":15},"children":["Request condition"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-condition-lifecycle","__idx":16},"children":["Request condition lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n NEW[new condition] -- \"POST\" --> INACTIVE\n INACTIVE -- \"/activate\" --> ACTIVE\n INACTIVE -- \"PATCH\" --> INACTIVE\n INACTIVE -- \"DELETE\" --> 404[\"404 Not found\"]\n ACTIVE -- \"PATCH\" --> ACTIVE\n ACTIVE -- \"/deactivate\" --> INACTIVE\n\n INVALID -- \"PATCH\" --> INACTIVE\n INVALID -- \"DELETE\" --> 404[\"404 Not found\"]\n","diagramHtml":"

POST

/activate

PATCH

DELETE

PATCH

/deactivate

PATCH

DELETE

404 Not found

new condition

INACTIVE

ACTIVE

INVALID

","diagramHtmlDark":"

POST

/activate

PATCH

DELETE

PATCH

/deactivate

PATCH

DELETE

404 Not found

new condition

INACTIVE

ACTIVE

INVALID

"},"children":["flowchart TD\n NEW[new condition] -- \"POST\" --> INACTIVE\n INACTIVE -- \"/activate\" --> ACTIVE\n INACTIVE -- \"PATCH\" --> INACTIVE\n INACTIVE -- \"DELETE\" --> 404[\"404 Not found\"]\n ACTIVE -- \"PATCH\" --> ACTIVE\n ACTIVE -- \"/deactivate\" --> INACTIVE\n\n INVALID -- \"PATCH\" --> INACTIVE\n INVALID -- \"DELETE\" --> 404[\"404 Not found\"]\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A request condition may transition to INVALID status if:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The resource is deleted."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All groups referenced in its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["requesterSettings"]}," have been deleted."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All groups referenced in its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessScopeSettings"]}," have been deleted."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All entitlement bundles referenced in its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessScopeSettings"]}," have been deleted."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All entitlements referenced in its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessScopeSettings"]}," have been deleted."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The resource opted out of entitlement management, but its ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["accessScopeSettings"]}," reference an entitlement bundle or entitlement."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The transition to INVALID status may occur when:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The system notices any of the aforementioned states during a related API operation (Create request, etc...)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Periodically when request condition integrity is checked"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request","__idx":17},"children":["Request"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"requeststatus-lifecycle","__idx":18},"children":["Request.status lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n NEW[new request] -- \"POST\" --> SUBMITTED\n SUBMITTED -- \"system action, request available in Access Requests\" --> PENDING\n SUBMITTED -- \"system action, request invalid\" --> REJECTED\n PENDING -- \"required approvals approved\" --> APPROVED\n PENDING -- \"any approval rejects\" --> DENIED\n PENDING -- \"requester cancels\" --> CANCELED\n PENDING -- \"request expires\" --> EXPIRED\n","diagramHtml":"

POST

system action, request available in Access Requests

system action, request invalid

required approvals approved

any approval rejects

requester cancels

request expires

new request

SUBMITTED

PENDING

REJECTED

APPROVED

DENIED

CANCELED

EXPIRED

","diagramHtmlDark":"

POST

system action, request available in Access Requests

system action, request invalid

required approvals approved

any approval rejects

requester cancels

request expires

new request

SUBMITTED

PENDING

REJECTED

APPROVED

DENIED

CANCELED

EXPIRED

"},"children":["flowchart TD\n NEW[new request] -- \"POST\" --> SUBMITTED\n SUBMITTED -- \"system action, request available in Access Requests\" --> PENDING\n SUBMITTED -- \"system action, request invalid\" --> REJECTED\n PENDING -- \"required approvals approved\" --> APPROVED\n PENDING -- \"any approval rejects\" --> DENIED\n PENDING -- \"requester cancels\" --> CANCELED\n PENDING -- \"request expires\" --> EXPIRED\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"requestgrantstatus-lifecycle","__idx":19},"children":["Request.grantStatus lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only applicable if Request.status === 'APPROVED'"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n NEW[Request.status==APPROVED] -- \"system action\" --> PENDING[Request.grantStatus=PENDING]\n PENDING -- \"assign to app success\" --> GRANTED[Request.grantStatus=GRANTED]\n PENDING -- \"add to group success\" --> GRANTED\n PENDING -- \"create grant success\" --> GRANTED\n PENDING -- \"assign to app failure\" --> FAILED[Request.grantStatus=FAILED]\n PENDING -- \"add to group failure\" --> FAILED\n PENDING -- \"create grant failure\" --> FAILED\n PENDING -- \"certain cases (app group?)\" --> MANUAL_GRANT_REQUIRED[Request.grantStatus=MANUAL_GRANT_REQUIRED]\n","diagramHtml":"

system action

assign to app success

add to group success

create grant success

assign to app failure

add to group failure

create grant failure

certain cases (app group?)

Request.status==APPROVED

Request.grantStatus=PENDING

Request.grantStatus=GRANTED

Request.grantStatus=FAILED

Request.grantStatus=MANUAL_GRANT_REQUIRED

","diagramHtmlDark":"

system action

assign to app success

add to group success

create grant success

assign to app failure

add to group failure

create grant failure

certain cases (app group?)

Request.status==APPROVED

Request.grantStatus=PENDING

Request.grantStatus=GRANTED

Request.grantStatus=FAILED

Request.grantStatus=MANUAL_GRANT_REQUIRED

"},"children":["flowchart TD\n NEW[Request.status==APPROVED] -- \"system action\" --> PENDING[Request.grantStatus=PENDING]\n PENDING -- \"assign to app success\" --> GRANTED[Request.grantStatus=GRANTED]\n PENDING -- \"add to group success\" --> GRANTED\n PENDING -- \"create grant success\" --> GRANTED\n PENDING -- \"assign to app failure\" --> FAILED[Request.grantStatus=FAILED]\n PENDING -- \"add to group failure\" --> FAILED\n PENDING -- \"create grant failure\" --> FAILED\n PENDING -- \"certain cases (app group?)\" --> MANUAL_GRANT_REQUIRED[Request.grantStatus=MANUAL_GRANT_REQUIRED]\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"requestrevocationstatus-lifecycle","__idx":20},"children":["Request.revocationStatus lifecycle"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only applicable if Request.accessDuration is defined."]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n NEW[Request.grantStatus==GRANTED] -- \"system action\" --> PENDING[Request.revocationStatus=PENDING, revocationScheduled=TIMESTAMP]\n PENDING -- \"accessDuration exceeded, successful access revocation\" --> REVOKED[Request.revocationStatus=REVOKED]\n PENDING -- \"accessDuration exceeded, failed access revocation\" --> FAILED[Request.revocationStatus=FAILED]\n","diagramHtml":"

system action

accessDuration exceeded, successful access revocation

accessDuration exceeded, failed access revocation

Request.grantStatus==GRANTED

Request.revocationStatus=PENDING, revocationScheduled=TIMESTAMP

Request.revocationStatus=REVOKED

Request.revocationStatus=FAILED

","diagramHtmlDark":"

system action

accessDuration exceeded, successful access revocation

accessDuration exceeded, failed access revocation

Request.grantStatus==GRANTED

Request.revocationStatus=PENDING, revocationScheduled=TIMESTAMP

Request.revocationStatus=REVOKED

Request.revocationStatus=FAILED

"},"children":["flowchart TD\n NEW[Request.grantStatus==GRANTED] -- \"system action\" --> PENDING[Request.revocationStatus=PENDING, revocationScheduled=TIMESTAMP]\n PENDING -- \"accessDuration exceeded, successful access revocation\" --> REVOKED[Request.revocationStatus=REVOKED]\n PENDING -- \"accessDuration exceeded, failed access revocation\" --> FAILED[Request.revocationStatus=FAILED]\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"collection","__idx":21},"children":["Collection"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"collection-lifecycle","__idx":22},"children":["Collection lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n NEW[No Collection] -- \"POST /collections\" --> EMPTY[Empty Collection]\n EMPTY -- \"POST /collections/{id}/resources\" --> COLLECTION[Collection with Resources]\n COLLECTION -- \"DELETE /collections/{id}/resources/{id}\" --> EMPTY\n COLLECTION -- \"DELETE /collections/{id}\" --> DELETED[No Collection]\n DELETED -- \"GET /collections/{id}\" --> 404[404 Not Found]\n","diagramHtml":"

POST /collections

POST /collections/{id}/resources

DELETE /collections/{id}/resources/{id}

DELETE /collections/{id}

GET /collections/{id}

404 Not Found

No Collection

Empty Collection

Collection with Resources

No Collection

","diagramHtmlDark":"

POST /collections

POST /collections/{id}/resources

DELETE /collections/{id}/resources/{id}

DELETE /collections/{id}

GET /collections/{id}

404 Not Found

No Collection

Empty Collection

Collection with Resources

No Collection

"},"children":["flowchart TD\n NEW[No Collection] -- \"POST /collections\" --> EMPTY[Empty Collection]\n EMPTY -- \"POST /collections/{id}/resources\" --> COLLECTION[Collection with Resources]\n COLLECTION -- \"DELETE /collections/{id}/resources/{id}\" --> EMPTY\n COLLECTION -- \"DELETE /collections/{id}\" --> DELETED[No Collection]\n DELETED -- \"GET /collections/{id}\" --> 404[404 Not Found]\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"collection-assignment-processing-lifecycle","__idx":23},"children":["Collection assignment processing lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n NO_ACCESS[No User Access] -- \"POST /collections/{id}/assignments\" --> GRANTS_PENDING[Collection Assigned, Grants Pending]\n GRANTS_PENDING -- \"background job\" --> GRANTS_PROCESSED[Collection Assigned, Grants Created]\n GRANTS_PENDING -- \"background job fails\" --> GRANTS_CREATION_FAILED[Syslog event for failed assignment]\n GRANTS_PROCESSED -- \"PUT /collections/{id}/resources/id\" --> GRANTS_PENDING[Collection Assignment Updated, Grants Pending]\n GRANTS_PROCESSED -- \"DELETE /collections/{id}/assignments/{id}\" --> GRANTS_REMOVAL_PENDING[Collection Assignment Removed, Grants Remain]\n GRANTS_REMOVAL_PENDING -- \"background job\" --> NO_ACCESS[Collection Assignment Removed, Grants Removed]\n","diagramHtml":"

POST /collections/{id}/assignments

background job

background job fails

PUT /collections/{id}/resources/id

DELETE /collections/{id}/assignments/{id}

background job

Collection Assignment Removed, Grants Removed

Collection Assignment Updated, Grants Pending

Collection Assigned, Grants Created

Syslog event for failed assignment

Collection Assignment Removed, Grants Remain

","diagramHtmlDark":"

POST /collections/{id}/assignments

background job

background job fails

PUT /collections/{id}/resources/id

DELETE /collections/{id}/assignments/{id}

background job

Collection Assignment Removed, Grants Removed

Collection Assignment Updated, Grants Pending

Collection Assigned, Grants Created

Syslog event for failed assignment

Collection Assignment Removed, Grants Remain

"},"children":["flowchart TD\n NO_ACCESS[No User Access] -- \"POST /collections/{id}/assignments\" --> GRANTS_PENDING[Collection Assigned, Grants Pending]\n GRANTS_PENDING -- \"background job\" --> GRANTS_PROCESSED[Collection Assigned, Grants Created]\n GRANTS_PENDING -- \"background job fails\" --> GRANTS_CREATION_FAILED[Syslog event for failed assignment]\n GRANTS_PROCESSED -- \"PUT /collections/{id}/resources/id\" --> GRANTS_PENDING[Collection Assignment Updated, Grants Pending]\n GRANTS_PROCESSED -- \"DELETE /collections/{id}/assignments/{id}\" --> GRANTS_REMOVAL_PENDING[Collection Assignment Removed, Grants Remain]\n GRANTS_REMOVAL_PENDING -- \"background job\" --> NO_ACCESS[Collection Assignment Removed, Grants Removed]\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"access-request-v1-request-types","__idx":24},"children":["Access Request v1 (Request types)"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n \"REQUEST-TYPES (v1)\" ||--|{ \"REQUESTS (v1)\": allow\n \"REQUEST-TYPES (v1)\" ||--|| \"OWNER (v1)\" : \"administrated by\"\n","diagramHtml":"

allow

administrated by

REQUEST-TYPES (v1)

REQUESTS (v1)

OWNER (v1)

","diagramHtmlDark":"

allow

administrated by

REQUEST-TYPES (v1)

REQUESTS (v1)

OWNER (v1)

"},"children":["erDiagram\n \"REQUEST-TYPES (v1)\" ||--|{ \"REQUESTS (v1)\": allow\n \"REQUEST-TYPES (v1)\" ||--|| \"OWNER (v1)\" : \"administrated by\"\n"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types"},"children":["Request Types (v1)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/requests"},"children":["Requests (v1)"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/listallrequestteams"},"children":["Owner (v1)"]}]}]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n \"REQUEST-TYPE (v1)\" {\n setting approvalSettings\n setting requestSettings\n setting resourceSettings\n }\n \"REQUEST-TYPE (v1)\" ||--|| \"OWNER (v1)\": \"administrated by\"\n \"REQUEST-TYPE (v1)\" ||--o{ \"REQUEST (v1)\" : allows\n","diagramHtml":"

administrated by

allows

REQUEST-TYPE (v1)

setting

approvalSettings

setting

requestSettings

setting

resourceSettings

OWNER (v1)

REQUEST (v1)

","diagramHtmlDark":"

administrated by

allows

REQUEST-TYPE (v1)

setting

approvalSettings

setting

requestSettings

setting

resourceSettings

OWNER (v1)

REQUEST (v1)

"},"children":["erDiagram\n \"REQUEST-TYPE (v1)\" {\n setting approvalSettings\n setting requestSettings\n setting resourceSettings\n }\n \"REQUEST-TYPE (v1)\" ||--|| \"OWNER (v1)\": \"administrated by\"\n \"REQUEST-TYPE (v1)\" ||--o{ \"REQUEST (v1)\" : allows\n"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n \"REQUEST (v1)\" ||..|| \"REQUEST-TYPE (v1)\" : \"allowed by\"\n \"REQUEST (v1)\" ||--|| \"CREATOR (v1)\" : created-by\n \"REQUEST (v1)\" ||--|| \"REQUESTER (v1)\" : requested-by\n \"REQUEST (v1)\" ||--o{ \"REQUESTER-FIELD-VALUES (v1)\" : \"provided by requester\"\n \"REQUEST (v1)\" ||--o{ \"APPROVAL (v1)\" : \"may require\"\n \"APPROVAL (v1)\" ||--|| \"APPROVER (v1)\": has\n \"APPROVAL (v1)\" ||--|| \"DECISION (v1)\": \"made by approver\"\n \"APPROVAL (v1)\" ||--|| \"APPROVER-FIELD-VALUES (v1)\": \"provided by approver\"\n \"REQUEST (v1)\" ||--|| \"ACTION (v1)\" : \"may generate\"\n \"ACTION (v1)\" ||--|| RESOURCE : has\n","diagramHtml":"

allowed by

created-by

requested-by

provided by requester

may require

has

made by approver

provided by approver

may generate

has

REQUEST (v1)

REQUEST-TYPE (v1)

CREATOR (v1)

REQUESTER (v1)

REQUESTER-FIELD-VALUES (v1)

APPROVAL (v1)

APPROVER (v1)

DECISION (v1)

APPROVER-FIELD-VALUES (v1)

ACTION (v1)

RESOURCE

","diagramHtmlDark":"

allowed by

created-by

requested-by

provided by requester

may require

has

made by approver

provided by approver

may generate

has

REQUEST (v1)

REQUEST-TYPE (v1)

CREATOR (v1)

REQUESTER (v1)

REQUESTER-FIELD-VALUES (v1)

APPROVAL (v1)

APPROVER (v1)

DECISION (v1)

APPROVER-FIELD-VALUES (v1)

ACTION (v1)

RESOURCE

"},"children":["erDiagram\n \"REQUEST (v1)\" ||..|| \"REQUEST-TYPE (v1)\" : \"allowed by\"\n \"REQUEST (v1)\" ||--|| \"CREATOR (v1)\" : created-by\n \"REQUEST (v1)\" ||--|| \"REQUESTER (v1)\" : requested-by\n \"REQUEST (v1)\" ||--o{ \"REQUESTER-FIELD-VALUES (v1)\" : \"provided by requester\"\n \"REQUEST (v1)\" ||--o{ \"APPROVAL (v1)\" : \"may require\"\n \"APPROVAL (v1)\" ||--|| \"APPROVER (v1)\": has\n \"APPROVAL (v1)\" ||--|| \"DECISION (v1)\": \"made by approver\"\n \"APPROVAL (v1)\" ||--|| \"APPROVER-FIELD-VALUES (v1)\": \"provided by approver\"\n \"REQUEST (v1)\" ||--|| \"ACTION (v1)\" : \"may generate\"\n \"ACTION (v1)\" ||--|| RESOURCE : has\n"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"erDiagram\n \"OWNER (v1)\" ||--|| \"TEAM (v1)\" : \"is\"\n \"TEAM (v1)\" ||--o{ \"MEMBER (v1)\" : has\n \"MEMBER (v1)\" ||--|| OKTA-USER : \"is\"\n","diagramHtml":"

is

has

is

OWNER (v1)

TEAM (v1)

MEMBER (v1)

OKTA-USER

","diagramHtmlDark":"

is

has

is

OWNER (v1)

TEAM (v1)

MEMBER (v1)

OKTA-USER

"},"children":["erDiagram\n \"OWNER (v1)\" ||--|| \"TEAM (v1)\" : \"is\"\n \"TEAM (v1)\" ||--o{ \"MEMBER (v1)\" : has\n \"MEMBER (v1)\" ||--|| OKTA-USER : \"is\"\n"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"request-type","__idx":25},"children":["Request Type"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-type-status-lifecycle","__idx":26},"children":["Request Type status lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n DRAFT -- \"/publish\" --> ACTIVE\n DRAFT -- \"DELETE /request-types/:requestTypeId\" --> 404[\"404 Not found\"]\n ACTIVE -- \"/un-publish\" --> DRAFT\n ACTIVE -- \"Invalid state detected during an operation\" --> DISABLED\n","diagramHtml":"

/publish

DELETE /request-types/:requestTypeId

/un-publish

Invalid state detected during an operation

404 Not found

DRAFT

ACTIVE

DISABLED

","diagramHtmlDark":"

/publish

DELETE /request-types/:requestTypeId

/un-publish

Invalid state detected during an operation

404 Not found

DRAFT

ACTIVE

DISABLED

"},"children":["flowchart TD\n DRAFT -- \"/publish\" --> ACTIVE\n DRAFT -- \"DELETE /request-types/:requestTypeId\" --> 404[\"404 Not found\"]\n ACTIVE -- \"/un-publish\" --> DRAFT\n ACTIVE -- \"Invalid state detected during an operation\" --> DISABLED\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The only terminal state for a Request Type is when the resource can no longer be found."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A DISABLED Request Type may be repaired through the administrative portal and re-enter a DRAFT or ACTIVE state."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following lifecycle operations are available on single Request Types."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/createrequesttype"},"children":["Add"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/publishrequesttype"},"children":["Publish"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/unpublishrequesttype"},"children":["Un-publish"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/request-types/deleterequesttype"},"children":["Delete"]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"v1-request","__idx":27},"children":["V1 Request"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"v1-requestrequeststatus-lifecycle","__idx":28},"children":["V1 Request.requestStatus lifecycle"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"flowchart TD\n OPEN -- \"Moved to pending in UI\" --> PENDING\n PENDING -- \"Moved to resolved in UI\" --> RESOLVED\n","diagramHtml":"

Moved to pending in UI

Moved to resolved in UI

OPEN

PENDING

RESOLVED

","diagramHtmlDark":"

Moved to pending in UI

Moved to resolved in UI

OPEN

PENDING

RESOLVED

"},"children":["flowchart TD\n OPEN -- \"Moved to pending in UI\" --> PENDING\n PENDING -- \"Moved to resolved in UI\" --> RESOLVED\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A Request progresses in its lifecycle state based on team or administrative actions on a variety of channels, including:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Access Request portal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Slack"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Microsoft teams"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The following lifecycle operations are available on single Request."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/iga/openapi/governance-production-requests-admin-v1-reference/requests/createrequest"},"children":["Add"]}]}]}]},"headings":[{"value":"Okta Identity Governance API","id":"okta-identity-governance-api","depth":1},{"value":"Domain model","id":"domain-model","depth":2},{"value":"Nouns","id":"nouns","depth":3},{"value":"Noun API reference","id":"noun-api-reference","depth":4},{"value":"Relationships","id":"relationships","depth":3},{"value":"Entitlement management","id":"entitlement-management","depth":2},{"value":"Resource - \"An object that may be governed\"","id":"resource---an-object-that-may-be-governed","depth":3},{"value":"Entitlements - A collection of entitlement with corresponding allowed values","id":"entitlements---a-collection-of-entitlement-with-corresponding-allowed-values","depth":3},{"value":"Entitlement Bundle","id":"entitlement-bundle","depth":3},{"value":"Collection - A group of resources and associated entitlements","id":"collection---a-group-of-resources-and-associated-entitlements","depth":3},{"value":"Grant","id":"grant","depth":3},{"value":"Principal Entitlement : Assigned entitlement with values for a Principal","id":"principal-entitlement--assigned-entitlement-with-values-for-a-principal","depth":3},{"value":"Governance object lifecycles","id":"governance-object-lifecycles","depth":2},{"value":"Campaign","id":"campaign","depth":3},{"value":"Campaign status lifecycle","id":"campaign-status-lifecycle","depth":4},{"value":"Request condition","id":"request-condition","depth":3},{"value":"Request condition lifecycle","id":"request-condition-lifecycle","depth":4},{"value":"Request","id":"request","depth":3},{"value":"Request.status lifecycle","id":"requeststatus-lifecycle","depth":4},{"value":"Request.grantStatus lifecycle","id":"requestgrantstatus-lifecycle","depth":4},{"value":"Request.revocationStatus lifecycle","id":"requestrevocationstatus-lifecycle","depth":4},{"value":"Collection","id":"collection","depth":3},{"value":"Collection lifecycle","id":"collection-lifecycle","depth":4},{"value":"Collection assignment processing lifecycle","id":"collection-assignment-processing-lifecycle","depth":4},{"value":"Access Request v1 (Request types)","id":"access-request-v1-request-types","depth":2},{"value":"Request Type","id":"request-type","depth":3},{"value":"Request Type status lifecycle","id":"request-type-status-lifecycle","depth":4},{"value":"V1 Request","id":"v1-request","depth":3},{"value":"V1 Request.requestStatus lifecycle","id":"v1-requestrequeststatus-lifecycle","depth":4}],"frontmatter":{"title":"Okta Identity Governance API","meta":[{"name":"description","content":"Learn how the Okta Identity Governance API works"}],"seo":{"title":"Okta Identity Governance API"}},"lastModified":"2026-02-25T19:30:46.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/iga","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}