{ "swagger":"2.0", "info":{ "description":"Oracle Access Governance REST APIs to automate and extend Identity Governance and Administration (IGA) capabilities. REST APIs are available for users with an Oracle Access Governance Premium license.", "version":"2026.04.29", "title":"Oracle Access Governance REST APIs", "x-summary":"Oracle Access Governance REST APIs to automate and extend Identity Governance and Administration (IGA) capabilities." }, "schemes":[ "http", "https" ], "produces":[ "application/json" ], "paths":{ "/access-governance/service-administration/20250331/orchestratedSystem/{orchestratedSystemId}/sod/analyze":{ "post":{ "tags":[ "OrchestratedSystems" ], "summary":"Request analysis of Separation of Duties (async)", "description":"Start analysis of Separation of Duties for an Orchestrated System. Request is asynchronous and returns a \nrequestId which can be used to check status.\n", "operationId":"AnalyzeSeparationOfDuties", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, { "in":"body", "name":"SeparationOfDutiesAnalysisDetails", "description":"Request details for performing Separation of Duties analysis.", "required":true, "schema":{ "$ref":"#/definitions/SeparationOfDutiesAnalysisDetails" } } ], "responses":{ "200":{ "description":"Perform analysis request accepted for processing.", "schema":{ "$ref":"#/definitions/SeparationOfDutiesAnalysisResponseDetails" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/SeparationOfDutiesAnalysisResponseDetails", "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystem-{orchestratedSystemId}-sod-analyze-post", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystem-orchestratedsystemid-sod-analyze-post" } }, "/access-governance/service-administration/20250331/orchestratedSystem/{orchestratedSystemId}/sod/status":{ "post":{ "tags":[ "OrchestratedSystems" ], "summary":"Get the status of Separation of Duties Analysis requests", "description":"Returns the current Separation of Duties Analysis status for input request IDs.\n", "operationId":"CheckSeparationOfDutiesStatus", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, { "in":"body", "name":"CheckSeparationOfDutiesStatus", "description":"Separation of Duties Analysis Request IDs.", "required":true, "schema":{ "$ref":"#/definitions/CheckSeparationOfDutiesStatus" } } ], "responses":{ "200":{ "description":"Separation of Duties status details are successfully fetched.", "schema":{ "$ref":"#/definitions/CheckSeparationOfDutiesStatusDetails" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/CheckSeparationOfDutiesStatusDetails", "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystem-{orchestratedSystemId}-sod-status-post", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystem-orchestratedsystemid-sod-status-post" } }, "/access-governance/service-administration/20250331/orchestratedSystems":{ "get":{ "tags":[ "OrchestratedSystems" ], "summary":"Get a list of Orchestrated Systems", "description":"Returns all active/inactive orchestrated systems and their details with support for pagination.\n", "operationId":"ListOrchestratedSystems", "parameters":[ { "name":"displayName", "in":"query", "description":"A filter to return only resources that match the given display names.", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi", "x-default-description":"null" }, { "name":"lifecycleState", "in":"query", "description":"A filter to return only orchestrated systems that match the given lifecycle states.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemLifecycleState" }, "collectionFormat":"multi", "x-default-description":"null" }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on from the following fields: displayName, lifecycleState.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"orchestratedSystemType", "in":"query", "description":"A filter to return only orchestrated systems that match the given types.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "OIG", "OCI", "AZUREAD", "DBUMORADB", "SALESFORCE", "SERVICENOW", "EBSUM", "EBSHRMS", "FA", "MSFTAD", "OID", "OUD", "DBUMMYSQL", "DBUMDB2", "MSTEAMS", "ELOQUA", "NETSUITE", "DBUMMSSQL", "EXPRESSFLATFILE", "GRC", "SIEBELUM", "PRIMAVERA", "PEOPLESOFT", "DBATORACLE", "ARCONPAM", "CERNERMILLENNIUM", "DBATMYSQL", "DBATMSSQL", "CERNERHI", "ZOOM", "JIRA", "WORKDAY", "SAPARIBA", "SUCCESSFACTORS", "SAPS4HANA", "SAPFIELDGLASS", "BEYONDTRUST", "ORACLEEPM", "SAPUM", "DBUMPOSTGRESQL", "AWS", "GOTOMEETING", "ORACLEAPEX", "ORACLECPQ", "ORACLEUNITY", "ORACLEOTMGTM", "ORACLEINFINITY", "WEBEX", "FALEARNING", "ORACLEWMS", "PANPRISMA", "GRCDIRECTCONFIG" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemType" }, "collectionFormat":"multi", "x-default-description":"null" }, { "name":"mode", "in":"query", "description":"A filter to return only orchestrated systems based onthe given modes.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE", "SOURCE_OF_IDENTITY_ATTRIBUTE", "BOTH_SOURCE_OF_IDENTITY_ATTRIBUTE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystem" }, "collectionFormat":"multi", "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemSortBy" }, { "name":"isIdentityCollectionSupported", "in":"query", "description":"A filter to return Orchestrated Systems where identity are managed using identity collection.", "required":false, "type":"boolean", "x-default-description":"null" }, { "name":"isSchemaDiscoverySupported", "in":"query", "description":"A filter to return Orchestrated Systems that support schema discovery operation.", "required":false, "type":"boolean", "x-default-description":"null" }, { "name":"isOrchestratedSystemActivated", "in":"query", "description":"A filter to return Orchestrated Systems that are activated.", "required":false, "type":"boolean", "x-default-description":"null" }, { "name":"ownerId", "in":"query", "description":"A filter to return only resources that are owned by the user.", "required":false, "type":"string", "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A paginated list of Orchestrated System summaries\n", "schema":{ "$ref":"#/definitions/OrchestratedSystemCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/OrchestratedSystemCollection", "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystems-get", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystems-get" } }, "/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}":{ "get":{ "tags":[ "OrchestratedSystems" ], "summary":"Get an Orchestrated System", "description":"Returns details of an orchestrated system with a given ID.\n", "operationId":"GetOrchestratedSystem", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieves the Orchestrated System for the given id", "schema":{ "$ref":"#/definitions/OrchestratedSystem" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/OrchestratedSystem", "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystems-{orchestratedSystemId}-get", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystems-orchestratedsystemid-get" } }, "/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/accountProfiles":{ "get":{ "tags":[ "OrchestratedSystems" ], "summary":"Get a list of Account Profiles", "description":"Returns details of all available account profiles associated with a given orchestrated system with support for pagination.\n", "operationId":"ListAccountProfiles", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on from the following fields: displayName, description.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"isDefaultOnly", "in":"query", "description":"Parameter to request only the default AccountProfile be returned.", "required":false, "type":"boolean", "default":false, "maxLength":255, "minLength":1 }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName", "timeLastModified" ], "x-obmcs-top-level-enum":"#/definitions/AccountProfileSortBy" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A list of Account Profile summaries\n", "schema":{ "$ref":"#/definitions/AccountProfileCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystems-{orchestratedSystemId}-accountProfiles-get", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystems-orchestratedsystemid-accountprofiles-get" } }, "/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/accountProfiles/{accountProfileId}":{ "get":{ "tags":[ "OrchestratedSystems" ], "summary":"Get an Account Profile", "description":"Returns account profile details linked to an orchestrated system with a given ID.\n", "operationId":"GetAccountProfile", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "name":"accountProfileId", "in":"path", "description":"Unique AccountProfile identifier.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieves the Account Profile for the given id", "schema":{ "$ref":"#/definitions/AccountProfile" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystems-{orchestratedSystemId}-accountProfiles-{accountProfileId}-get", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystems-orchestratedsystemid-accountprofiles-accountprofileid-get" } }, "/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/lookupAttributes":{ "get":{ "tags":[ "OrchestratedSystems" ], "summary":"Get a list of items from lookup table", "description":"Returns a list of key-value pairs for a given attribute associated with an orchestrated system. These lookup values can be used for performing inbound/outbound transformation or defining permission levels in an access bundle.\n", "operationId":"ListLookupAttributes", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "name":"lookupType", "in":"query", "description":"The lookup Id of the resource we want to request", "required":true, "type":"string" }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"keywordContains", "in":"query", "description":"Keyword to filter on from the following fields: label. Only one keyword may be provided.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided." }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"List of data returned from Look Up table", "schema":{ "$ref":"#/definitions/LookupCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/LookupCollection", "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystems-{orchestratedSystemId}-lookupAttributes-get", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystems-orchestratedsystemid-lookupattributes-get" } }, "/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/permissionAttributes":{ "post":{ "tags":[ "OrchestratedSystems" ], "summary":"Find Permission Attributes", "description":"Returns metadata and a set of permissions associated with a given orchestrated system.\n", "operationId":"FindOrchestratedSystemPermissionAttributes", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "in":"body", "name":"OrchestratedSystemPermissionDetails", "description":"List of Permissions used to find attributes", "required":true, "schema":{ "$ref":"#/definitions/OrchestratedSystemPermissionIdCollection" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Permission Attributes Metadata", "schema":{ "$ref":"#/definitions/OrchestratedSystemAttributes" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/OrchestratedSystemPermissionIdCollection", "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystems-{orchestratedSystemId}-permissionAttributes-post", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystems-orchestratedsystemid-permissionattributes-post" } }, "/access-governance/service-administration/20250331/orchestratedSystems/{orchestratedSystemId}/permissions":{ "get":{ "tags":[ "OrchestratedSystems" ], "summary":"Get a list of Permissions for an Orchestrated System", "description":"Returns a list of permissions associated with a given orchestrated system with support for pagination of \nthe first 10,000 records matching the search criteria.\n", "operationId":"ListOrchestratedSystemPermissions", "parameters":[ { "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, { "name":"keywordContains", "in":"query", "description":"Keyword to filter on from the following fields: displayName. Only one keyword may be provided.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided." }, { "name":"permissionTypeId", "in":"query", "description":"The id of the permission type that the permissions are attached to.", "required":false, "type":"string", "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"domainName", "in":"query", "description":"Domain Name", "required":false, "type":"string", "x-default-description":"domainName" }, { "name":"resourceType", "in":"query", "description":"The resource type filter to fetch permissions for OCI systems. Required when orchestratedSystem type is OCI.\n", "required":false, "type":"string", "enum":[ "APP_ROLE", "GROUP" ], "x-obmcs-top-level-enum":"#/definitions/PermissionResourceType", "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of Permission objects", "schema":{ "$ref":"#/definitions/PermissionCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/PermissionCollection", "x-internal-id":"access-governance-service-administration-20250331-orchestratedSystems-{orchestratedSystemId}-permissions-get", "x-filename-id":"access-governance-service-administration-20250331-orchestratedsystems-orchestratedsystemid-permissions-get" } }, "/access-governance/service-administration/20250331/organizations":{ "get":{ "tags":[ "Organizations" ], "summary":"Gets a list of Organizations", "description":"Returns a list of Organizations with support for pagination.\n", "operationId":"ListOrganizations", "parameters":[ { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"status", "in":"query", "description":"A filter to return only organizations that match the give status or ALL to match all organizations.", "required":false, "type":"string", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ], "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for name is ascending.\n", "required":false, "type":"string", "enum":[ "createdBy", "displayName", "name", "timeUpdated" ], "x-obmcs-top-level-enum":"#/definitions/OrganizationSortBy", "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of Organization summary objects.", "schema":{ "$ref":"#/definitions/OrganizationCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/OrganizationCollection", "x-internal-id":"access-governance-service-administration-20250331-organizations-get", "x-filename-id":"access-governance-service-administration-20250331-organizations-get" } }, "/access-governance/service-administration/20250331/organizations/{organizationId}/members":{ "get":{ "tags":[ "Organizations" ], "summary":"Gets a list of all identities that are part of organization", "description":"Returns list of members for a given organization with support for pagination.\n", "operationId":"ListOrganizationMembers", "parameters":[ { "name":"organizationId", "in":"path", "description":"The unique id for an Organization. Available values can be found using the ListOrganizations operation.", "required":true, "type":"string" }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The List of members of given Organization was successfully queried.", "schema":{ "$ref":"#/definitions/AccessGovernanceTypeCollection" }, "headers":{ "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGovernanceTypeCollection", "x-internal-id":"access-governance-service-administration-20250331-organizations-{organizationId}-members-get", "x-filename-id":"access-governance-service-administration-20250331-organizations-organizationid-members-get" } }, "/access-governance/access-controls/20250331/accessBundles":{ "get":{ "tags":[ "AccessBundles" ], "summary":"Get a list of Access Bundles", "description":"Returns details of all available access bundles with support for pagination.\n", "operationId":"ListAccessBundles", "parameters":[ { "name":"keywordContains", "in":"query", "description":"Keyword to filter on. Only one keyword may be provided. Default is empty string.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided. Default is empty string." }, { "name":"status", "in":"query", "description":"A filter to be used for finding entities with the given status.\n", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/Status" }, { "name":"requestableBy", "in":"query", "description":"A filter to return only resources that match the given identityType.", "required":false, "type":"string", "maxLength":255, "minLength":1, "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy", "x-default-description":"null" }, { "name":"approvalWorkflowId", "in":"query", "description":"A filter to return only resources that match the given approval workflow id.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"orchestratedSystemId", "in":"query", "description":"A filter to return only resources that match given orchestrated system identifier.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"A filter to be used for sorting Access Bundles with the given sort by field. \nOnly one sort order may be provided. \n", "required":false, "type":"string", "default":"timeUpdatedOn", "enum":[ "name", "timeUpdated", "createdBy" ], "x-obmcs-top-level-enum":"#/definitions/AccessBundleSortBy" }, { "name":"userId", "in":"query", "description":"Identifier of the user who is performing the operation", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, { "name":"organizationId", "in":"query", "description":"A filter to return only resources that match the given organization id.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" } ], "responses":{ "200":{ "description":"A list of Access Bundle Summaries\n", "schema":{ "$ref":"#/definitions/AccessBundleCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessBundleCollection", "x-internal-id":"access-governance-access-controls-20250331-accessBundles-get", "x-filename-id":"access-governance-access-controls-20250331-accessbundles-get" }, "post":{ "tags":[ "AccessBundles" ], "summary":"Create an Access Bundle", "description":"Creates a new access bundle with the specified details.\n", "operationId":"CreateAccessBundle", "parameters":[ { "in":"body", "name":"CreateAccessBundleDetails", "description":"Details for the new Access Bundle\n", "required":true, "schema":{ "$ref":"#/definitions/CreateAccessBundleDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The newly created Access Bundle\n", "schema":{ "$ref":"#/definitions/AccessBundle" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessBundle", "x-internal-id":"access-governance-access-controls-20250331-accessBundles-post", "x-filename-id":"access-governance-access-controls-20250331-accessbundles-post" } }, "/access-governance/access-controls/20250331/accessBundles/{accessBundleId}":{ "get":{ "tags":[ "AccessBundles" ], "summary":"Get an Access Bundle", "description":"Returns details of an access bundle with a given ID.\n", "operationId":"GetAccessBundle", "parameters":[ { "name":"accessBundleId", "in":"path", "description":"A filter to be used for finding Access Bundles with the given id. \nAvailable values can be found using the ListAccessBundles operation.\n", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Access Bundle for the given id\n", "schema":{ "$ref":"#/definitions/AccessBundle" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-access-controls-20250331-accessBundles-{accessBundleId}-get", "x-filename-id":"access-governance-access-controls-20250331-accessbundles-accessbundleid-get" }, "put":{ "tags":[ "AccessBundles" ], "summary":"Update an Access Bundle", "description":"Updates the details of an existing access bundle with a given ID.\n", "operationId":"UpdateAccessBundle", "parameters":[ { "name":"accessBundleId", "in":"path", "description":"A filter to be used for finding Access Bundles with the given id. \nAvailable values can be found using the ListAccessBundles operation.\n", "required":true, "type":"string" }, { "in":"body", "name":"UpdateAccessBundleDetails", "description":"Details for the updated Access Bundle.\n", "required":true, "schema":{ "$ref":"#/definitions/UpdateAccessBundleDetails" } }, { "name":"if-match", "in":"header", "description":"For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n", "required":false, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The updated Access Bundle\n", "schema":{ "$ref":"#/definitions/AccessBundle" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessBundle", "x-internal-id":"access-governance-access-controls-20250331-accessBundles-{accessBundleId}-put", "x-filename-id":"access-governance-access-controls-20250331-accessbundles-accessbundleid-put" }, "delete":{ "tags":[ "AccessBundles" ], "summary":"Delete an Access Bundle", "description":"Deletes an access bundle with a given ID.\n", "operationId":"DeleteAccessBundle", "parameters":[ { "name":"accessBundleId", "in":"path", "description":"A filter to be used for finding Access Bundles with the given id. \nAvailable values can be found using the ListAccessBundles operation.\n", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"Empty response body indicating successful deletion of Access Bundle\n", "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessBundle", "x-internal-id":"access-governance-access-controls-20250331-accessBundles-{accessBundleId}-delete", "x-filename-id":"access-governance-access-controls-20250331-accessbundles-accessbundleid-delete" } }, "/access-governance/access-controls/20250331/accessBundles/{accessBundleId}/activate":{ "patch":{ "tags":[ "AccessBundles" ], "summary":"Activate an Access Bundle", "description":"Activates an access bundle currently in draft state with a given ID.\nAn error will be returned if the Access Bundle is not currently in DRAFT status.\n", "operationId":"ActivateAccessBundle", "parameters":[ { "name":"accessBundleId", "in":"path", "description":"A filter to be used for finding Access Bundles with the given id. \nAvailable values can be found using the ListAccessBundles operation.\n", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The activated Access Bundle", "schema":{ "$ref":"#/definitions/AccessBundle" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessBundle", "x-internal-id":"access-governance-access-controls-20250331-accessBundles-{accessBundleId}-activate-patch", "x-filename-id":"access-governance-access-controls-20250331-accessbundles-accessbundleid-activate-patch" } }, "/access-governance/access-controls/20250331/accessGuardrails":{ "get":{ "tags":[ "AccessGuardrails" ], "summary":"Get a list of Access Guardrails", "description":"Returns details of all available access guardrails with support for pagination.\n", "operationId":"ListAccessGuardrails", "parameters":[ { "name":"name", "in":"query", "description":"A name to filter results\n", "required":false, "type":"string", "maxLength":100, "x-default-description":"null" }, { "name":"keywordContains", "in":"query", "description":"Keyword to filter on. Only one keyword may be provided. Default is empty string.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided. Default is empty string." }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"ownerId", "in":"query", "description":"Owner ID to filter on", "required":false, "type":"string" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A list of Access Guardrail Summaries", "schema":{ "$ref":"#/definitions/AccessGuardrailCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGuardrailCollection", "x-internal-id":"access-governance-access-controls-20250331-accessGuardrails-get", "x-filename-id":"access-governance-access-controls-20250331-accessguardrails-get" }, "post":{ "tags":[ "AccessGuardrails" ], "summary":"Creates a new Access Guardrail", "description":"Creates a new Access Guardrail.\n\nNote: Currently, when editing access guardrails via the UI, fields related to condition handling may need to be reapplied.\n", "operationId":"CreateAccessGuardrail", "parameters":[ { "in":"body", "name":"CreateAccessGuardrailDetails", "description":"Details for the new access guardrail.", "required":true, "schema":{ "$ref":"#/definitions/CreateAccessGuardrailDetails" } }, { "name":"opc-retry-token", "in":"header", "description":"A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n", "required":false, "type":"string", "maxLength":64, "minLength":1 }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Access Guardrail was successfully created.", "schema":{ "$ref":"#/definitions/AccessGuardrail" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGuardrail", "x-internal-id":"access-governance-access-controls-20250331-accessGuardrails-post", "x-filename-id":"access-governance-access-controls-20250331-accessguardrails-post" } }, "/access-governance/access-controls/20250331/accessGuardrails/analyze":{ "post":{ "tags":[ "AccessGuardrails" ], "summary":"Analyze Access Guardrails", "description":"Analyze Access Guardrails against Identities for any violations.\n", "operationId":"AnalyzeAccessGuardrails", "parameters":[ { "in":"body", "name":"AnalyzeAccessGuardrailsDetails", "description":"Details for the Access Guardrails analysis.", "required":true, "schema":{ "$ref":"#/definitions/AnalyzeAccessGuardrailsDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Access Guardrail analysis was successfully completed.", "schema":{ "$ref":"#/definitions/AnalyzeAccessGuardrailsResult" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AnalyzeAccessGuardrailsResult", "x-internal-id":"access-governance-access-controls-20250331-accessGuardrails-analyze-post", "x-filename-id":"access-governance-access-controls-20250331-accessguardrails-analyze-post" } }, "/access-governance/access-controls/20250331/accessGuardrails/{accessGuardrailId}":{ "get":{ "tags":[ "AccessGuardrails" ], "summary":"Get an Access Guardrail", "description":"Returns details of an access guardrail with a given ID.\n", "operationId":"GetAccessGuardrail", "parameters":[ { "name":"accessGuardrailId", "in":"path", "description":"Unique Access Guardrail identifier", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Access Guardrail for the given id", "schema":{ "$ref":"#/definitions/AccessGuardrail" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGuardrail", "x-internal-id":"access-governance-access-controls-20250331-accessGuardrails-{accessGuardrailId}-get", "x-filename-id":"access-governance-access-controls-20250331-accessguardrails-accessguardrailid-get" }, "put":{ "tags":[ "AccessGuardrails" ], "summary":"Update the Access Guardrail identified by id", "description":"Updates the Access Guardrail.\n\nCurrently, when editing access guardrails via the UI, fields related to condition handling may need to be reapplied.\n", "operationId":"UpdateAccessGuardrail", "parameters":[ { "name":"accessGuardrailId", "in":"path", "description":"Unique Access Guardrail identifier", "required":true, "type":"string" }, { "in":"body", "name":"UpdateAccessGuardrailDetails", "description":"The information to be updated.", "required":true, "schema":{ "$ref":"#/definitions/UpdateAccessGuardrailDetails" } }, { "name":"if-match", "in":"header", "description":"For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n", "required":false, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Access Guardrail was successfully updated.", "schema":{ "$ref":"#/definitions/AccessGuardrail" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGuardrail", "x-internal-id":"access-governance-access-controls-20250331-accessGuardrails-{accessGuardrailId}-put", "x-filename-id":"access-governance-access-controls-20250331-accessguardrails-accessguardrailid-put" }, "delete":{ "tags":[ "AccessGuardrails" ], "summary":"Delete an Access Guardrail", "description":"Deletes a Access Guardrail resource by identifier.", "operationId":"DeleteAccessGuardrail", "parameters":[ { "name":"accessGuardrailId", "in":"path", "description":"Unique Access Guardrail identifier", "required":true, "type":"string" }, { "name":"if-match", "in":"header", "description":"For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n", "required":false, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"The Access Guardrail was successfully deleted.", "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGuardrail", "x-internal-id":"access-governance-access-controls-20250331-accessGuardrails-{accessGuardrailId}-delete", "x-filename-id":"access-governance-access-controls-20250331-accessguardrails-accessguardrailid-delete" } }, "/access-governance/access-controls/20250331/accessRequests":{ "get":{ "tags":[ "AccessRequests" ], "summary":"Get a list of Access Requests", "description":"Returns details of all available access requests with support for pagination.\n", "operationId":"ListAccessRequests", "parameters":[ { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of Access Request Summary objects", "schema":{ "$ref":"#/definitions/AccessRequestCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessRequestCollection", "x-internal-id":"access-governance-access-controls-20250331-accessRequests-get", "x-filename-id":"access-governance-access-controls-20250331-accessrequests-get" }, "post":{ "tags":[ "AccessRequests" ], "summary":"Create an Access Request", "description":"Creates a new access request for an identity with the specified details. \nYou can create an Access Request only for Workforce Identities.\n", "operationId":"CreateAccessRequest", "parameters":[ { "in":"body", "name":"CreateAccessRequestDetails", "description":"Details for the new Access Request.", "required":true, "schema":{ "$ref":"#/definitions/CreateAccessRequestDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The newly created Access Request", "schema":{ "$ref":"#/definitions/AccessRequest" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessRequest", "x-internal-id":"access-governance-access-controls-20250331-accessRequests-post", "x-filename-id":"access-governance-access-controls-20250331-accessrequests-post" } }, "/access-governance/access-controls/20250331/accessRequests/actions/precheck":{ "post":{ "tags":[ "AccessRequests" ], "summary":"Precheck an Access Request", "description":"Checks a proposed access request for access guardrails & separation of duties violations.\nYou can call this API before creating an access request when needed. \n", "operationId":"PrecheckAccessRequest", "parameters":[ { "in":"body", "name":"CreateAccessRequestDetails", "description":"Details for the proposed Access Request.", "required":true, "schema":{ "$ref":"#/definitions/CreateAccessRequestDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The results of the precheck analysis.", "schema":{ "$ref":"#/definitions/AccessRequestPrecheckResult" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessRequest", "x-internal-id":"access-governance-access-controls-20250331-accessRequests-actions-precheck-post", "x-filename-id":"access-governance-access-controls-20250331-accessrequests-actions-precheck-post" } }, "/access-governance/access-controls/20250331/accessRequests/extension":{ "post":{ "tags":[ "AccessRequests" ], "summary":"Create an extension request", "description":"Creates a new extension request for an access that is about to expire. \nIf your request is granted, access will continue for the approved period.\n", "operationId":"CreateExtensionRequest", "parameters":[ { "in":"body", "name":"CreateExtensionRequestDetails", "description":"Details for the new Extension Request", "required":true, "schema":{ "$ref":"#/definitions/CreateExtensionRequestDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The newly created Extension Request", "schema":{ "$ref":"#/definitions/ExtensionRequest" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/ExtensionRequest", "x-internal-id":"access-governance-access-controls-20250331-accessRequests-extension-post", "x-filename-id":"access-governance-access-controls-20250331-accessrequests-extension-post" } }, "/access-governance/access-controls/20250331/accessRequests/{accessRequestId}":{ "get":{ "tags":[ "AccessRequests" ], "summary":"Get an Access Request", "description":"Returns details of an access request with a given ID.\n", "operationId":"GetAccessRequest", "parameters":[ { "name":"accessRequestId", "in":"path", "description":"Unique AccessRequest identifier", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Access Request for the given id", "schema":{ "$ref":"#/definitions/AccessRequest" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-access-controls-20250331-accessRequests-{accessRequestId}-get", "x-filename-id":"access-governance-access-controls-20250331-accessrequests-accessrequestid-get" } }, "/access-governance/access-controls/20250331/approvalWorkflows":{ "get":{ "tags":[ "ApprovalWorkflows" ], "summary":"Get a list of Approval Processes", "description":"Returns details of all available approval workflows with support for pagination.\n", "operationId":"ListApprovalWorkflows", "parameters":[ { "name":"ownerId", "in":"query", "description":"Owner ID to filter on", "required":false, "type":"string" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Default sort by is displayName. \n", "required":false, "type":"string", "default":"displayName", "enum":[ "displayName", "state", "creatorId", "timeCreated" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessSortBy" }, { "name":"processId", "in":"query", "description":"The approval process ID to filter on. If specified all existing versions of the approval process are provided.", "required":false, "type":"string", "x-default-description":"If not specified, the draft and latest versions of all approval processes are provided." }, { "name":"state", "in":"query", "description":"A filter to return only the workflows that match the given approval process state.", "required":false, "type":"string", "enum":[ "DRAFT", "PUBLISHING", "ACTIVE", "DISABLED", "DELETING" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessState", "x-default-description":"If not specified, all matching approval processes are provided regardless of state." }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"outOfBoxCategory", "in":"query", "description":"Indicates the category of out of box workflow to filter on. If specified, 'isOutOfBox' is assumed true and 'isTransition' is ignored.", "required":false, "type":"string", "enum":[ "UNMATCHED", "OWNERSHIP", "TRANSITION" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessOutOfBoxCategory", "x-default-description":"If not specified, null is assumed." }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of ApprovalProcessSummary objects.", "schema":{ "$ref":"#/definitions/ApprovalProcessCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/ApprovalProcessCollection", "x-internal-id":"access-governance-access-controls-20250331-approvalWorkflows-get", "x-filename-id":"access-governance-access-controls-20250331-approvalworkflows-get" } }, "/access-governance/access-controls/20250331/approvals":{ "get":{ "tags":[ "Approvals" ], "summary":"Get a list of Approval tasks", "description":"Returns details of all available approval tasks with support for pagination.\n", "operationId":"ListApprovals", "parameters":[ { "name":"type", "in":"query", "description":"Approval type filters for listing and counting approvals.", "required":false, "type":"string", "default":"ALL_EXCEPT_ACCESS_REVIEWS", "enum":[ "ACCESS_REQUESTS_ONLY", "REQUESTS_FOR_ACCESS_ONLY", "REVISION_REQUESTS_ONLY", "ALL_EXCEPT_ACCESS_REVIEWS" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalTypeFilter" }, { "name":"assignmentType", "in":"query", "description":"The type of assignment the approval is for.", "required":false, "type":"string", "enum":[ "ACCESS_BUNDLE", "ROLE", "IDENTITY_GROUP", "ACTIVE_GROUP", "CONSUMER_GROUP", "AG_ORGANIZATION" ], "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "x-default-description":"If not specified, the assumption is the approval is for an access request." }, { "name":"assigneeId", "in":"query", "description":"The global id for the assignee to filter on. \nThis parameter is required when an accessRequestId is not provided.\n", "required":false, "type":"string" }, { "name":"assigneeScope", "in":"query", "description":"Assignee scope to filter on. \n'DIRECT' to filter on the tasks where the assignee id or authenticated user is the direct assignee,\nor 'INDIRECT' to filter on the tasks where the assignee has indirect approval rights.\n", "required":false, "type":"string", "enum":[ "DIRECT", "INDIRECT" ], "x-obmcs-top-level-enum":"#/definitions/TaskAssigneeScope", "x-default-description":"If not specified, results will contain both direct & indirect assignee scopes." }, { "name":"accessRequestId", "in":"query", "description":"The access request id to filter on. This parameter is required when assigneeId is not provided. \n", "required":false, "type":"string" }, { "name":"status", "in":"query", "description":"List of task statuses to filter on.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "PENDING_APPROVAL", "APPROVED", "ASSIGNED", "MODIFIED", "REJECTED", "REMOVED", "DELETED", "INFO_REQUESTED", "ESCALATED", "ERROR", "CANCELLED" ], "x-obmcs-top-level-enum":"#/definitions/TaskStatus" }, "collectionFormat":"multi", "x-default-description":"If not specified, will default to PENDING_APPROVAL, INFO_REQUESTED, and ESCALATED." }, { "name":"dueBefore", "in":"query", "description":"Return only tasks due before the specified date.", "required":false, "type":"string", "format":"date-time", "x-default-description":"If not specified, the dueBefore filter will not be applied." }, { "name":"requestedAfter", "in":"query", "description":"Return only instances created after the specified date.", "required":false, "type":"string", "format":"date-time", "x-default-description":"If not specified, the requestedAfter filter will not be applied." }, { "name":"keywordContains", "in":"query", "description":"Keyword to use to filter against the names of the requestor and beneficiary.", "required":false, "type":"string", "x-default-description":"If not specified, the keywords filter will not be applied." }, { "name":"instanceTags", "in":"query", "description":"List of tag filters to use.\nEach position in the array maps to the tag in the InstanceTags enum that is in the same position.\nSet the value to true to include instances that carry the tag.\nSet the value to false to exclude instances that carry the tag.\nSet the value to null in order to not apply the filter.\n", "required":false, "type":"array", "items":{ "type":"boolean" }, "collectionFormat":"multi", "x-default-description":"If not specified, the instance tags filter will not be applied." }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Default sort by is 'dueDate'.\n", "required":false, "type":"string", "enum":[ "requestor", "beneficiary", "dueDate", "access" ], "x-default-description":"If not specified, sorting will be by due date." }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of Task objects.", "schema":{ "$ref":"#/definitions/TaskCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Task", "x-internal-id":"access-governance-access-controls-20250331-approvals-get", "x-filename-id":"access-governance-access-controls-20250331-approvals-get" }, "post":{ "tags":[ "Approvals" ], "summary":"Act on one or more Approval Tasks.", "description":"Act on one or more Approval Tasks.\n", "operationId":"DecideApprovals", "parameters":[ { "in":"body", "name":"ApprovalDecisionDetails", "description":"One or more Approval Task decisions.", "required":true, "schema":{ "$ref":"#/definitions/ApprovalDecisionDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successfully updated some or all of the approval tasks.", "schema":{ "$ref":"#/definitions/ApprovalDecisionResults" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Task", "x-internal-id":"access-governance-access-controls-20250331-approvals-post", "x-filename-id":"access-governance-access-controls-20250331-approvals-post" } }, "/access-governance/access-controls/20250331/approvals/me":{ "get":{ "tags":[ "Approvals" ], "summary":"Get a list of my Approval tasks", "description":"Returns a list of approval tasks awaiting your approval with pagination support. \nPassword authentication is required to access this API.\n", "operationId":"ListMyApprovals", "parameters":[ { "name":"type", "in":"query", "description":"Approval type filters for listing and counting approvals.", "required":false, "type":"string", "default":"ALL_EXCEPT_ACCESS_REVIEWS", "enum":[ "ACCESS_REQUESTS_ONLY", "REQUESTS_FOR_ACCESS_ONLY", "REVISION_REQUESTS_ONLY", "ALL_EXCEPT_ACCESS_REVIEWS" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalTypeFilter" }, { "name":"assignmentType", "in":"query", "description":"The type of assignment the approval is for.", "required":false, "type":"string", "enum":[ "ACCESS_BUNDLE", "ROLE", "IDENTITY_GROUP", "ACTIVE_GROUP", "CONSUMER_GROUP", "AG_ORGANIZATION" ], "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "x-default-description":"If not specified, the assumption is the approval is for an access request." }, { "name":"assigneeScope", "in":"query", "description":"Assignee scope to filter on. \n'DIRECT' to filter on the tasks where the assignee id or authenticated user is the direct assignee,\nor 'INDIRECT' to filter on the tasks where the assignee has indirect approval rights.\n", "required":false, "type":"string", "enum":[ "DIRECT", "INDIRECT" ], "x-obmcs-top-level-enum":"#/definitions/TaskAssigneeScope", "x-default-description":"If not specified, results will contain both direct & indirect assignee scopes." }, { "name":"accessRequestId", "in":"query", "description":"The access request id to filter on. This parameter is required when assigneeId is not provided. \n", "required":false, "type":"string" }, { "name":"status", "in":"query", "description":"List of task statuses to filter on.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "PENDING_APPROVAL", "APPROVED", "ASSIGNED", "MODIFIED", "REJECTED", "REMOVED", "DELETED", "INFO_REQUESTED", "ESCALATED", "ERROR", "CANCELLED" ], "x-obmcs-top-level-enum":"#/definitions/TaskStatus" }, "collectionFormat":"multi", "x-default-description":"If not specified, will default to PENDING_APPROVAL, INFO_REQUESTED, and ESCALATED." }, { "name":"dueBefore", "in":"query", "description":"Return only tasks due before the specified date.", "required":false, "type":"string", "format":"date-time", "x-default-description":"If not specified, the dueBefore filter will not be applied." }, { "name":"requestedAfter", "in":"query", "description":"Return only instances created after the specified date.", "required":false, "type":"string", "format":"date-time", "x-default-description":"If not specified, the requestedAfter filter will not be applied." }, { "name":"keywordContains", "in":"query", "description":"Keyword to use to filter against the names of the requestor and beneficiary.", "required":false, "type":"string", "x-default-description":"If not specified, the keywords filter will not be applied." }, { "name":"instanceTags", "in":"query", "description":"List of tag filters to use.\nEach position in the array maps to the tag in the InstanceTags enum that is in the same position.\nSet the value to true to include instances that carry the tag.\nSet the value to false to exclude instances that carry the tag.\nSet the value to null in order to not apply the filter.\n", "required":false, "type":"array", "items":{ "type":"boolean" }, "collectionFormat":"multi", "x-default-description":"If not specified, the instance tags filter will not be applied." }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Default sort by is 'dueDate'.\n", "required":false, "type":"string", "enum":[ "requestor", "beneficiary", "dueDate", "access" ], "x-default-description":"If not specified, sorting will be by due date." }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of Task objects.", "schema":{ "$ref":"#/definitions/TaskCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Task", "x-internal-id":"access-governance-access-controls-20250331-approvals-me-get", "x-filename-id":"access-governance-access-controls-20250331-approvals-me-get" } }, "/access-governance/access-controls/20250331/approvals/workRequest":{ "post":{ "tags":[ "Approvals" ], "summary":"Act on Approval Tasks in Bulk (Async)", "description":"Asynchronously act on one or more Approval Tasks in bulk. \nUse this approach when actioning over 50 approval tasks.\n", "operationId":"CreateWorkRequest", "parameters":[ { "in":"body", "name":"ApprovalDecisionWorkRequestDetails", "description":"Contains a single action & comment for a set of approval tasks.", "required":true, "schema":{ "$ref":"#/definitions/ApprovalDecisionWorkRequestDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "202":{ "description":"Created work request to bulk action the task decisions.", "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-work-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Task", "x-internal-id":"access-governance-access-controls-20250331-approvals-workRequest-post", "x-filename-id":"access-governance-access-controls-20250331-approvals-workrequest-post" } }, "/access-governance/access-controls/20250331/approvals/workRequest/{workRequestId}":{ "get":{ "tags":[ "Approvals" ], "summary":"Get status for asynchronous bulk Approval Task creation.", "description":"Returns task actions in bulk status.", "operationId":"GetWorkRequest", "parameters":[ { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, { "name":"workRequestId", "in":"path", "description":"Unique work request identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"The details of status for async creates task actions in bulk", "schema":{ "$ref":"#/definitions/ApprovalDecisionResults" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Task", "x-internal-id":"access-governance-access-controls-20250331-approvals-workRequest-{workRequestId}-get", "x-filename-id":"access-governance-access-controls-20250331-approvals-workrequest-workrequestid-get" } }, "/access-governance/access-controls/20250331/approvals/{taskId}":{ "get":{ "tags":[ "Approvals" ], "summary":"Get an Approval task", "description":"Returns details of an approval task with a given ID.\n", "operationId":"GetTask", "parameters":[ { "name":"taskId", "in":"path", "description":"Unique approval task identifier.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The details of an Approval task.", "schema":{ "$ref":"#/definitions/Task" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Task", "x-internal-id":"access-governance-access-controls-20250331-approvals-{taskId}-get", "x-filename-id":"access-governance-access-controls-20250331-approvals-taskid-get" } }, "/access-governance/access-controls/20250331/identityCollections":{ "get":{ "tags":[ "IdentityCollections" ], "summary":"Get a list of Identity Collections", "description":"Returns a list of Identity Collections.\n", "operationId":"ListIdentityCollections", "parameters":[ { "name":"userId", "in":"query", "description":"Identifier of the user who is performing the operation", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"keywordContains", "in":"query", "description":"Keyword to filter on. Only one keyword may be provided. Default is empty string.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided. Default is empty string." }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"status", "in":"query", "description":"A filter to be used for finding entities with the given status.\n", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/Status" }, { "name":"isManagedAtTargetOrchestratedSystem", "in":"query", "description":"If true will return ICs managed at orchestratedSystem", "required":false, "type":"boolean", "default":false }, { "name":"identityId", "in":"query", "description":"The ID of the resource that the permissions are attached to.", "required":false, "type":"string", "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of Permission Group objects.", "schema":{ "$ref":"#/definitions/IdentityCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-access-controls-20250331-identityCollections-get", "x-filename-id":"access-governance-access-controls-20250331-identitycollections-get" }, "post":{ "tags":[ "IdentityCollections" ], "summary":"Creates a new Identity Collection", "description":"Creates a new Identity Collection.\n", "operationId":"CreateIdentityCollection", "parameters":[ { "in":"body", "name":"CreateIdentityCollectionDetails", "description":"Details for the new Identity Collection.", "required":true, "schema":{ "$ref":"#/definitions/CreateIdentityCollectionDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Identity group was successfully created.", "schema":{ "$ref":"#/definitions/IdentityCollectionResponse" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/IdentityCollectionResponse", "x-internal-id":"access-governance-access-controls-20250331-identityCollections-post", "x-filename-id":"access-governance-access-controls-20250331-identitycollections-post" } }, "/access-governance/access-controls/20250331/identityCollections/{identityCollectionId}":{ "get":{ "tags":[ "IdentityCollections" ], "summary":"Get an Identity Collection", "description":"Gets a Identity Collections by identifier", "operationId":"GetIdentityCollection", "parameters":[ { "name":"identityCollectionId", "in":"path", "description":"Unique Identity Collection identifier", "required":true, "type":"string" }, { "name":"insights", "in":"query", "description":"Boolean query param to pass if extra data is required or not\n", "required":false, "type":"boolean", "default":false }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieves the Identity Collection with the given id", "schema":{ "$ref":"#/definitions/IdentityCollectionResponse" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/IdentityCollectionResponse", "x-internal-id":"access-governance-access-controls-20250331-identityCollections-{identityCollectionId}-get", "x-filename-id":"access-governance-access-controls-20250331-identitycollections-identitycollectionid-get" }, "put":{ "tags":[ "IdentityCollections" ], "summary":"Update the Identity Collection identified by the id", "description":"Updates the Identity Collection", "operationId":"UpdateIdentityCollection", "parameters":[ { "name":"identityCollectionId", "in":"path", "description":"Unique Identity Collection identifier", "required":true, "type":"string" }, { "in":"body", "name":"UpdateIdentityCollectionDetails", "description":"The information to be updated.", "required":true, "schema":{ "$ref":"#/definitions/UpdateIdentityCollectionDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Identity group was successfully updated.", "schema":{ "$ref":"#/definitions/IdentityCollectionResponse" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/IdentityCollectionResponse", "x-internal-id":"access-governance-access-controls-20250331-identityCollections-{identityCollectionId}-put", "x-filename-id":"access-governance-access-controls-20250331-identitycollections-identitycollectionid-put" }, "delete":{ "tags":[ "IdentityCollections" ], "summary":"Delete an Identity Collection", "description":"Deletes a Identity group resource by identifier", "operationId":"DeleteIdentityCollection", "parameters":[ { "name":"identityCollectionId", "in":"path", "description":"Unique Identity Collection identifier", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"The Identity group was successfully deleted.", "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/IdentityCollectionResponse", "x-internal-id":"access-governance-access-controls-20250331-identityCollections-{identityCollectionId}-delete", "x-filename-id":"access-governance-access-controls-20250331-identitycollections-identitycollectionid-delete" } }, "/access-governance/access-controls/20250331/identityCollections/{identityCollectionId}/members":{ "get":{ "tags":[ "IdentityCollections" ], "summary":"Get a list of members in an identity collection", "description":"Returns list of members for a given identity collection\n", "operationId":"ListIdentityCollectionMembers", "parameters":[ { "name":"identityCollectionId", "in":"path", "description":"Unique Identity Collection identifier", "required":true, "type":"string" }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The List of members of given Identity Collection was successfully queried.", "schema":{ "$ref":"#/definitions/AccessGovernanceTypeCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGovernanceTypeCollection", "x-internal-id":"access-governance-access-controls-20250331-identityCollections-{identityCollectionId}-members-get", "x-filename-id":"access-governance-access-controls-20250331-identitycollections-identitycollectionid-members-get" } }, "/access-governance/access-controls/20250331/permissions/{permissionId}/actions/revoke":{ "post":{ "tags":[ "Permissions" ], "summary":"Revoke a granted permission", "description":"Revokes a granted permission for a given global identity. \nGrant type must be DIRECT or REQUEST.\nFor Access Bundles, permissionType should be ACCESS_BUNDLE.\nFor Permissions & Roles, permissionType should be PERMISSION.\nRequest is asynchronous.\n", "operationId":"RevokePermission", "parameters":[ { "name":"permissionId", "in":"path", "description":"A permission identifier.\n", "required":true, "type":"string" }, { "in":"body", "name":"RevokePermissionDetails", "description":"Details for revoking the permission.\n", "required":true, "schema":{ "$ref":"#/definitions/RevokePermissionDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Revocation in progress.\n", "schema":{ "$ref":"#/definitions/RevokePermissionStatus" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/RevokePermissionStatus", "x-internal-id":"access-governance-access-controls-20250331-permissions-{permissionId}-actions-revoke-post", "x-filename-id":"access-governance-access-controls-20250331-permissions-permissionid-actions-revoke-post" } }, "/access-governance/access-controls/20250331/policies":{ "get":{ "tags":[ "Policies" ], "summary":"Get a list of Policies", "description":"Returns details of all available policies with support for pagination.\n", "operationId":"ListPolicies", "parameters":[ { "name":"keywordContains", "in":"query", "description":"Keyword to filter on. Only one keyword may be provided. Default is empty string.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided. Default is empty string." }, { "name":"status", "in":"query", "description":"A filter to be used for finding entities with the given status.\n", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/Status" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A list of Policy Summaries", "schema":{ "$ref":"#/definitions/PolicyCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/PolicyCollection", "x-internal-id":"access-governance-access-controls-20250331-policies-get", "x-filename-id":"access-governance-access-controls-20250331-policies-get" }, "post":{ "tags":[ "Policies" ], "summary":"Create a Policy", "description":"Creates a new policy with the specified details.\n", "operationId":"CreatePolicy", "parameters":[ { "in":"body", "name":"CreatePolicyDetails", "description":"Details for the new Policy", "required":true, "schema":{ "$ref":"#/definitions/CreatePolicyDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The newly created Policy", "schema":{ "$ref":"#/definitions/Policy" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Policy", "x-internal-id":"access-governance-access-controls-20250331-policies-post", "x-filename-id":"access-governance-access-controls-20250331-policies-post" } }, "/access-governance/access-controls/20250331/policies/{policyId}":{ "get":{ "tags":[ "Policies" ], "summary":"Get Policy", "description":"Returns details of a policy with a given ID.\n", "operationId":"GetPolicy", "parameters":[ { "name":"policyId", "in":"path", "description":"Unique Policy identifier", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Policy for the given id\n", "schema":{ "$ref":"#/definitions/Policy" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-access-controls-20250331-policies-{policyId}-get", "x-filename-id":"access-governance-access-controls-20250331-policies-policyid-get" }, "put":{ "tags":[ "Policies" ], "summary":"Update a Policy", "description":"Updates the details of an existing policy with a given ID.\n", "operationId":"UpdatePolicy", "parameters":[ { "name":"policyId", "in":"path", "description":"Unique Policy identifier", "required":true, "type":"string" }, { "in":"body", "name":"UpdatePolicyDetails", "description":"Details for the updated Policy.\n", "required":true, "schema":{ "$ref":"#/definitions/UpdatePolicyDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The updated Policy\n", "schema":{ "$ref":"#/definitions/Policy" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Policy", "x-internal-id":"access-governance-access-controls-20250331-policies-{policyId}-put", "x-filename-id":"access-governance-access-controls-20250331-policies-policyid-put" }, "delete":{ "tags":[ "Policies" ], "summary":"Delete a policy", "description":"Deletes a policy with a given ID.\n", "operationId":"DeletePolicy", "parameters":[ { "name":"policyId", "in":"path", "description":"Unique Policy identifier", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"The Policy was successfully deleted.", "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Policy", "x-internal-id":"access-governance-access-controls-20250331-policies-{policyId}-delete", "x-filename-id":"access-governance-access-controls-20250331-policies-policyid-delete" } }, "/access-governance/access-controls/20250331/roles":{ "get":{ "tags":[ "Roles" ], "summary":"Get a list of Roles", "description":"Returns details of all available roles with support for pagination.\n", "operationId":"ListRoles", "parameters":[ { "name":"keywordContains", "in":"query", "description":"Keyword to filter on. Only one keyword may be provided. Default is empty string.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided. Default is empty string." }, { "name":"status", "in":"query", "description":"A filter to be used for finding entities with the given status.\n", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/Status" }, { "name":"requestableBy", "in":"query", "description":"A filter to return only resources that match the given identityType.", "required":false, "type":"string", "maxLength":255, "minLength":1, "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy", "x-default-description":"null" }, { "name":"approvalWorkflowId", "in":"query", "description":"A filter to return only resources that match the given approval workflow id.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"userId", "in":"query", "description":"Identifier of the user who is performing the operation", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, { "name":"organizationId", "in":"query", "description":"A filter to return only resources that match the given organization id.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" } ], "responses":{ "200":{ "description":"A list of Role Summaries", "schema":{ "$ref":"#/definitions/RoleCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/RoleCollection", "x-internal-id":"access-governance-access-controls-20250331-roles-get", "x-filename-id":"access-governance-access-controls-20250331-roles-get" }, "post":{ "tags":[ "Roles" ], "summary":"Creates a new Role", "description":"Creates a new role with the specified details.\n", "operationId":"CreateRole", "parameters":[ { "in":"body", "name":"CreateRoleDetails", "description":"Details for the new Role", "required":true, "schema":{ "$ref":"#/definitions/CreateRoleDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The newly created Role\n", "schema":{ "$ref":"#/definitions/Role" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Role", "x-internal-id":"access-governance-access-controls-20250331-roles-post", "x-filename-id":"access-governance-access-controls-20250331-roles-post" } }, "/access-governance/access-controls/20250331/roles/{roleId}":{ "get":{ "tags":[ "Roles" ], "summary":"Get Role", "description":"Returns details of a role with a given ID.\n", "operationId":"GetRole", "parameters":[ { "name":"roleId", "in":"path", "description":"Unique Role identifier", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The Role for the given id\n", "schema":{ "$ref":"#/definitions/Role" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-access-controls-20250331-roles-{roleId}-get", "x-filename-id":"access-governance-access-controls-20250331-roles-roleid-get" }, "put":{ "tags":[ "Roles" ], "summary":"Update Role", "description":"Updates the details of an existing role with a given ID.\n", "operationId":"UpdateRole", "parameters":[ { "name":"roleId", "in":"path", "description":"Unique Role identifier", "required":true, "type":"string" }, { "in":"body", "name":"UpdateRoleDetails", "description":"Details for the updated Role.\n", "required":true, "schema":{ "$ref":"#/definitions/UpdateRoleDetails" } }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The updated Role", "schema":{ "$ref":"#/definitions/Role" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Role", "x-internal-id":"access-governance-access-controls-20250331-roles-{roleId}-put", "x-filename-id":"access-governance-access-controls-20250331-roles-roleid-put" }, "delete":{ "tags":[ "Roles" ], "summary":"Delete Role", "description":"Deletes a role with a given ID.\n", "operationId":"DeleteRole", "parameters":[ { "name":"roleId", "in":"path", "description":"Unique Role identifier", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"Empty response body indicating successful deletion of Role\n", "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/Role", "x-internal-id":"access-governance-access-controls-20250331-roles-{roleId}-delete", "x-filename-id":"access-governance-access-controls-20250331-roles-roleid-delete" } }, "/access-governance/access-controls/20250331/separationOfDuties/actions/status":{ "post":{ "tags":[ "SeparationOfDuties" ], "summary":"Check status of the separation of duties request(s)", "description":"Returns the current status for one or more separation of duties requests.\n", "operationId":"CheckSeparationOfDutiesStatus", "parameters":[ { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, { "name":"opc-retry-token", "in":"header", "description":"A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n", "required":false, "type":"string", "maxLength":64, "minLength":1 }, { "name":"if-match", "in":"header", "description":"For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n", "required":false, "type":"string" }, { "in":"body", "name":"CheckSeparationOfDutiesStatusDetails", "description":"Separation of duties request IDs.", "required":true, "schema":{ "$ref":"#/definitions/CheckSeparationOfDutiesStatusDetails" } } ], "responses":{ "200":{ "description":"Separation of duties request statuses.", "schema":{ "$ref":"#/definitions/SeparationOfDutiesStatusResponse" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/SeparationOfDutiesStatusResponse", "x-internal-id":"access-governance-access-controls-20250331-separationOfDuties-actions-status-post", "x-filename-id":"access-governance-access-controls-20250331-separationofduties-actions-status-post" } }, "/access-governance/identities/20250331/identities":{ "get":{ "tags":[ "Identities" ], "summary":"List Identities", "description":"Returns all active identities (Workforce and Consumers) details with support for pagination of the first\n10,000 records matching the search criteria.\n", "operationId":"ListIdentities", "parameters":[ { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"attributes", "in":"query", "description":"The list of Attributes used to filter.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"attributeValues", "in":"query", "description":"A list of attribute values to use as matching filters.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"bindingOperator", "in":"query", "description":"A parameter to bind expressions.", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "ANY" ], "x-obmcs-top-level-enum":"#/definitions/BindingOperator" }, { "name":"operators", "in":"query", "description":"A parameter to form logical expressions.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TO", "FROM", "CONTAINS", "NOT_CONTAINS" ], "x-obmcs-top-level-enum":"#/definitions/Operator" }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"consumerFilter", "in":"query", "description":"A filter for consumer/workforce types.", "required":false, "type":"string", "enum":[ "CONSUMER", "WORKFORCE" ], "x-obmcs-top-level-enum":"#/definitions/IdentityConsumerFilterTypes", "x-default-description":"Default behavior includes all types" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The list of Identities successfully queried.", "schema":{ "$ref":"#/definitions/AccessGovernanceTypeCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGovernanceTypeCollection", "x-internal-id":"access-governance-identities-20250331-identities-get", "x-filename-id":"access-governance-identities-20250331-identities-get" } }, "/access-governance/identities/20250331/identities/attributeValues/{identityAttributeId}":{ "get":{ "tags":[ "Identities" ], "summary":"Get Identity Attributes values", "description":"Returns a list of Identity Attribute values.", "operationId":"ListIdentityAttributeValues", "parameters":[ { "name":"identityAttributeId", "in":"path", "description":"Identity attribute Id in path", "required":true, "type":"string" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A page of Identity Attribute value objects.", "schema":{ "$ref":"#/definitions/IdentityAttributeValueSummaryCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/IdentityAttributeValueSummaryCollection", "x-internal-id":"access-governance-identities-20250331-identities-attributeValues-{identityAttributeId}-get", "x-filename-id":"access-governance-identities-20250331-identities-attributevalues-identityattributeid-get" } }, "/access-governance/identities/20250331/identities/attributes":{ "get":{ "tags":[ "Identities" ], "summary":"Get Identity Attributes", "description":"Gets Identity Attributes.", "operationId":"ListIdentityAttributes", "parameters":[ { "name":"name", "in":"query", "description":"A name to filter results\n", "required":false, "type":"string", "maxLength":100, "x-default-description":"null" }, { "name":"attributesType", "in":"query", "description":"The type of attributes", "required":false, "type":"string", "enum":[ "FULL", "CUSTOM_ON_IDENTITY_PAGE", "CUSTOM_CAMPAIGN_SELECTION", "CUSTOM_CAMPAIGN_EVENT", "CUSTOM_IDENTITY_LIFE_CYCLE", "CUSTOM_ON_MATCHING_RULES", "CUSTOM_ON_MAPPING_RULES", "CUSTOM_ON_ENTITY_VIEW", "OWNERSHIP_CAMPAIGN_VIEW" ], "x-obmcs-top-level-enum":"#/definitions/AttributesType", "x-default-description":"FULL" }, { "name":"attributesNamespace", "in":"query", "description":"The namespace of attributes", "required":false, "type":"string", "enum":[ "ALL", "DEFAULTS", "CUSTOM", "AFFILIATION", "ALL_NO_AFFILIATION" ], "x-obmcs-top-level-enum":"#/definitions/AttributesNamespace", "x-default-description":"ALL" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieves the Identity Attributes.", "schema":{ "$ref":"#/definitions/IdentityAttributeCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/IdentityAttributeCollection", "x-internal-id":"access-governance-identities-20250331-identities-attributes-get", "x-filename-id":"access-governance-identities-20250331-identities-attributes-get" } }, "/access-governance/identities/20250331/identities/operators":{ "get":{ "tags":[ "Identities" ], "summary":"Get Identity Operators", "description":"Gets Identity Operators.", "operationId":"ListIdentityOperators", "parameters":[ { "name":"name", "in":"query", "description":"A name to filter results\n", "required":false, "type":"string", "maxLength":100, "x-default-description":"null" }, { "name":"attributeType", "in":"query", "description":"Attribute Type Query Param", "required":false, "type":"string", "default":"All" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieves the Identity Attributes.", "schema":{ "$ref":"#/definitions/IdentityOperatorCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-internal-id":"access-governance-identities-20250331-identities-operators-get", "x-filename-id":"access-governance-identities-20250331-identities-operators-get" } }, "/access-governance/identities/20250331/identities/{identityId}":{ "get":{ "tags":[ "Identities" ], "summary":"Get an Identity", "description":"Returns identity details, including identity attributes with a given ID.\n", "operationId":"GetIdentity", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieves the Identity with the given id.", "schema":{ "$ref":"#/definitions/AccessGovernanceEntity" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGovernanceEntity", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-get", "x-filename-id":"access-governance-identities-20250331-identities-identityid-get" } }, "/access-governance/identities/20250331/identities/{identityId}/accounts":{ "get":{ "tags":[ "Identities" ], "summary":"List Accounts", "description":"Returns a list of Accounts. Note keyword searches are limited to the name field and the first keyword query param.\n", "operationId":"ListAccounts", "parameters":[ { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"A list of Account objects.", "schema":{ "$ref":"#/definitions/AccountCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/TargetAccountCollection", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-accounts-get", "x-filename-id":"access-governance-identities-20250331-identities-identityid-accounts-get" } }, "/access-governance/identities/20250331/identities/{identityId}/accounts/{accountId}":{ "get":{ "tags":[ "Identities" ], "summary":"Get an Account", "description":"Gets an Account by identifier.", "operationId":"GetIdentityAccount", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"accountId", "in":"path", "description":"Unique Account id.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Retrieves the Account for the given Account Id.", "schema":{ "$ref":"#/definitions/AccessGovernanceEntity" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGovernanceEntity", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-accounts-{accountId}-get", "x-filename-id":"access-governance-identities-20250331-identities-identityid-accounts-accountid-get" } }, "/access-governance/identities/20250331/identities/{identityId}/accounts/{accountId}/action/delete":{ "post":{ "tags":[ "Identities" ], "summary":"Delete an Account", "description":"Deletes an Account by identifier.", "operationId":"DeleteIdentityAccount", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"accountId", "in":"path", "description":"Unique Account id.", "required":true, "type":"string" }, { "name":"orchestratedSystemId", "in":"query", "description":"A filter to return only resources that match given orchestrated system identifier.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Deletes the Account for the given Account Id.", "schema":{ "$ref":"#/definitions/AccountData" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccountData", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-accounts-{accountId}-action-delete-post", "x-filename-id":"access-governance-identities-20250331-identities-identityid-accounts-accountid-action-delete-post" } }, "/access-governance/identities/20250331/identities/{identityId}/accounts/{accountId}/action/disable":{ "post":{ "tags":[ "Identities" ], "summary":"Disable an Account", "description":"Disables an Account by identifier.", "operationId":"DisableIdentityAccount", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"accountId", "in":"path", "description":"Unique Account id.", "required":true, "type":"string" }, { "name":"orchestratedSystemId", "in":"query", "description":"A filter to return only resources that match given orchestrated system identifier.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Disables the Account for the given Account Id.", "schema":{ "$ref":"#/definitions/AccountData" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccountData", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-accounts-{accountId}-action-disable-post", "x-filename-id":"access-governance-identities-20250331-identities-identityid-accounts-accountid-action-disable-post" } }, "/access-governance/identities/20250331/identities/{identityId}/accounts/{accountId}/action/enable":{ "post":{ "tags":[ "Identities" ], "summary":"Enable an Account", "description":"Enables an Account by identifier.", "operationId":"EnableIdentityAccount", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"accountId", "in":"path", "description":"Unique Account id.", "required":true, "type":"string" }, { "name":"orchestratedSystemId", "in":"query", "description":"A filter to return only resources that match given orchestrated system identifier.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Enables the Account for the given Account Id.", "schema":{ "$ref":"#/definitions/AccountData" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccountData", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-accounts-{accountId}-action-enable-post", "x-filename-id":"access-governance-identities-20250331-identities-identityid-accounts-accountid-action-enable-post" } }, "/access-governance/identities/20250331/identities/{identityId}/action/activate":{ "post":{ "tags":[ "Identities" ], "summary":"Activate an Identity", "description":"Activates an Identity for a given ID. This re-provisions terminated accounts and accesses.\\n Terminated accounts with Grant Type __Policy__ can only be re-provisioned into Oracle Access Governance.", "operationId":"ActivateIdentity", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Activates the Identity for the given Identity Id.", "schema":{ "$ref":"#/definitions/ActivatedIdentityResponse" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/ActivatedIdentityResponse", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-action-activate-post", "x-filename-id":"access-governance-identities-20250331-identities-identityid-action-activate-post" } }, "/access-governance/identities/20250331/identities/{identityId}/action/terminate":{ "post":{ "tags":[ "Identities" ], "summary":"Terminate an Identity", "description":"Terminates all accounts and associated accesses for an identity immediately without an approval for a given id. \\n Accounts with Grant Type __DIRECT__ or __Direct__ cannot be terminated.", "operationId":"TerminateIdentity", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Terminates the Identity for the given Identity Id.", "schema":{ "$ref":"#/definitions/TerminatedIdentityResponse" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/TerminatedIdentityResponse", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-action-terminate-post", "x-filename-id":"access-governance-identities-20250331-identities-identityid-action-terminate-post" } }, "/access-governance/identities/20250331/identities/{identityId}/permissions":{ "get":{ "tags":[ "Identities" ], "summary":"List an Identity's Permissions", "description":"Returns a list of Permissions for the given Identity. Note keyword searches are limited to the name field and the first keyword query param.\n", "operationId":"ListIdentityPermissions", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A list of Permission objects.", "schema":{ "$ref":"#/definitions/AccessGovernanceTypeCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGovernanceTypeCollection", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-permissions-get", "x-filename-id":"access-governance-identities-20250331-identities-identityid-permissions-get" } }, "/access-governance/identities/20250331/identities/{identityId}/roles":{ "get":{ "tags":[ "Identities" ], "summary":"List an Identity's Roles", "description":"Returns a list of Roles for the given Identity. Note keyword searches are limited to the name field and the first keyword query param.\n", "operationId":"ListIdentityRoles", "parameters":[ { "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, { "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, { "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, { "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, { "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, { "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"A list of Role objects.", "schema":{ "$ref":"#/definitions/AccessGovernanceTypeCollection" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" }, "opc-next-page":{ "type":"string", "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/AccessGovernanceTypeCollection", "x-internal-id":"access-governance-identities-20250331-identities-{identityId}-roles-get", "x-filename-id":"access-governance-identities-20250331-identities-identityid-roles-get" } }, "/access-governance/identities/20250331/types/{typeId}":{ "get":{ "tags":[ "Types" ], "summary":"Gets a Type available in Access Governance by id", "description":"Returns available data component types and its schema. For example, to fetch Identity schema, use agcs.Identity as the typeID.\n", "operationId":"GetType", "parameters":[ { "name":"typeId", "in":"path", "description":"The Type Id of an entity.", "required":true, "type":"string" }, { "name":"orchestratedSystemId", "in":"query", "description":"A filter to return only resources that match given orchestrated system identifier.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, { "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"The details of the Type available in Access Governance.", "schema":{ "$ref":"#/definitions/TypeDetails" }, "headers":{ "etag":{ "type":"string", "description":"For optimistic concurrency control. See `if-match`.\n" }, "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-related-resource":"#/definitions/TypeDetails", "x-internal-id":"access-governance-identities-20250331-types-{typeId}-get", "x-filename-id":"access-governance-identities-20250331-types-typeid-get" } }, "/access-governance/access-reviews/20250331/campaigns":{ "post":{ "tags":[ "Campaigns" ], "operationId":"CreateCampaign", "summary":"Create a new campaign", "description":"Creates a new Access or Ownership campaign.\n", "parameters":[ { "name":"CreateCampaignDetails", "description":"Details for the new campaign.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateCampaignDetails" } }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "200":{ "description":"The campaign was created successfully.", "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Campaign" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-post" }, "get":{ "tags":[ "Campaigns" ], "operationId":"ListCampaigns", "summary":"Get Campaigns", "description":"Returns a list of campaigns with support of pagination.\n", "parameters":[ { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/KeywordContainsQueryParam" }, { "$ref":"#/parameters/CampaignStatusParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/CampaignCollection", "responses":{ "200":{ "description":"A page of campaignSummary objects.", "schema":{ "$ref":"#/definitions/CampaignCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-get" } }, "/access-governance/access-reviews/20250331/campaigns/{campaignId}":{ "get":{ "tags":[ "Campaigns" ], "operationId":"GetCampaign", "summary":"Get the details of an existing campaign.", "description":"Get the details of an existing campaign.\n", "parameters":[ { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/CampaignIdPathParam" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "200":{ "description":"The details of a campaign.", "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Campaign" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-get" }, "delete":{ "tags":[ "Campaigns" ], "operationId":"DeleteCampaign", "summary":"Deletes the campaign", "description":"Deletes an existing campaign.\n", "parameters":[ { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/CampaignIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "204":{ "description":"The campaign was successfully deleted.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-delete", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-delete" }, "put":{ "tags":[ "Campaigns" ], "operationId":"UpdateCampaign", "summary":"Update Campaign", "description":"Updates an existing campaign. You can edit a campaign in the Draft or Scheduled state.\n", "parameters":[ { "name":"UpdateCampaignDetails", "description":"Details for updating a campaign.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/CreateCampaignDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/CampaignIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "200":{ "description":"The campaign was successfully updated.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/Campaign" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-put", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-put" } }, "/access-governance/access-reviews/20250331/campaigns/{campaignId}/stages/{stageId}/reviewers":{ "get":{ "tags":[ "Campaigns" ], "operationId":"ListStageReviewers", "summary":"Get Pending reviewers for a given stage", "description":"Returns a list of pending reviewers for a given stage.\n", "parameters":[ { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/KeywordContainsQueryParam" }, { "$ref":"#/parameters/TemplateIdQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/CampaignIdPathParam" }, { "$ref":"#/parameters/StageIdPathParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "200":{ "description":"The list of pending reviewers for the given stage.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-total-items":{ "description":"The total number of items.\n", "type":"integer" } }, "schema":{ "$ref":"#/definitions/StageReviewerSummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-stages-{stageId}-reviewers-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-stages-stageid-reviewers-get" } }, "/access-governance/access-reviews/20250331/campaigns/{campaignId}/overviewReport":{ "get":{ "tags":[ "Campaigns" ], "operationId":"GetOverviewReport", "summary":"Get the overview report for the given campaign", "description":"Retrieve the overview report for the given campaign.", "parameters":[ { "$ref":"#/parameters/CampaignIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/OverviewReport", "responses":{ "200":{ "description":"The overview report for the given campaign.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/OverviewReport" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-overviewReport-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-overviewreport-get" } }, "/access-governance/access-reviews/20250331/campaigns/{campaignId}/actions/changeOwner":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ChangeOwner", "summary":"Change Campaign Owner", "description":"Change the campaign Owner.\n", "parameters":[ { "name":"ChangeOwnerDetails", "description":"Details for change owner.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ChangeOwnerDetails" } }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/CampaignIdPathParam" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "200":{ "description":"Successfully changed campaign owner.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-actions-changeOwner-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-actions-changeowner-post" } }, "/access-governance/access-reviews/20250331/campaigns/{campaignId}/actions/terminate":{ "post":{ "tags":[ "Campaigns" ], "operationId":"TerminateCampaign", "summary":"Terminate a campaign instance or series", "description":"Terminate an ongoing campaign instance or series.\n", "parameters":[ { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/CampaignIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/TerminateTypeQueryParam" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "202":{ "description":"Created work request to terminate the campaign.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-work-request-id":{ "description":"Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-actions-terminate-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-actions-terminate-post" } }, "/access-governance/access-reviews/20250331/campaigns/{campaignId}/actions/approve":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ApproveCampaign", "summary":"Approve or sign-off a campaign", "description":"Approve or sign-off a campaign.\n", "parameters":[ { "$ref":"#/parameters/RetryTokenHeader" }, { "$ref":"#/parameters/CampaignIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/Campaign", "responses":{ "200":{ "description":"Successfully approve or sign-off the campaign.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-{campaignId}-actions-approve-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-campaignid-actions-approve-post" } }, "/access-governance/access-reviews/20250331/campaigns/systemBrowser/ag/criteria":{ "get":{ "tags":[ "Campaigns" ], "operationId":"ListAgCriteria", "summary":"Get Access Governance criteria type with its states", "description":"Retrieves a list of available Access Governance criteria types and their availability states. Applicable for Ownership Reviews.", "parameters":[ { "$ref":"#/parameters/SystemCriteriaStateQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" } ], "x-related-resource":"#/definitions/AgCriteriaSummaryCollection", "responses":{ "200":{ "description":"A list of Ag criteria type with its states.", "schema":{ "$ref":"#/definitions/AgCriteriaSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-systemBrowser-ag-criteria-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-systembrowser-ag-criteria-get" } }, "/access-governance/access-reviews/20250331/campaigns/attributes/{agEntityType}":{ "get":{ "tags":[ "Campaigns" ], "operationId":"ListEntityAttributes", "summary":"Get Entity Attributes", "description":"Retrieves a list of entity attributes used in creating an Ownership Campaign.", "parameters":[ { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/LocaleQueryParam" }, { "$ref":"#/parameters/AgEntityTypePathParam" } ], "x-related-resource":"#/definitions/EntityAttributeSummary", "responses":{ "200":{ "description":"Retrieves the Permissions Attributes.", "schema":{ "$ref":"#/definitions/EntityAttributeCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-attributes-{agEntityType}-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-attributes-agentitytype-get" } }, "/access-governance/access-reviews/20250331/campaigns/attributes/{agEntityType}/{attributeId}/values":{ "get":{ "tags":[ "Campaigns" ], "operationId":"ListFilteredEntityAttributeValues", "summary":"List attribute values for the given entity type", "description":"Returns attribute values for a specific entity type. Applicable for an Ownership Campaign.\n", "parameters":[ { "$ref":"#/parameters/AttributeIdPathParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/AgEntityTypePathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/EntityAttributeValue", "responses":{ "200":{ "description":"The list of permission attributes values was successfully queried.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/EntityAttributeValueCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "409":{ "$ref":"#/responses/409" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-attributes-{agEntityType}-{attributeId}-values-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-attributes-agentitytype-attributeid-values-get" } }, "/access-governance/access-reviews/20250331/campaigns/operators":{ "get":{ "tags":[ "Campaigns" ], "operationId":"ListOperators", "summary":"Get valid operators and data types", "description":"Retrieves a list of operators and data types. Applicable for Resource Ownership reviews.\n", "parameters":[ { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/OperatorSummaryCollection", "responses":{ "200":{ "description":"A list of valid operators.", "schema":{ "$ref":"#/definitions/OperatorSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-operators-get", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-operators-get" } }, "/access-governance/access-reviews/20250331/campaigns/resources":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListResources", "summary":"Get Resources", "description":"Retrieves a list of resources (What are users accessing?) for running access reviews.", "parameters":[ { "$ref":"#/parameters/ListResourcesDetails" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/ResourceCollection", "responses":{ "200":{ "description":"A page of resource objects.", "schema":{ "$ref":"#/definitions/ResourceCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-resources-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-resources-post" } }, "/access-governance/access-reviews/20250331/campaigns/permissions":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListPermissions", "summary":"Get Permissions", "description":"Retrieves a list of permissions for running access reviews.\n", "parameters":[ { "$ref":"#/parameters/ListPermissionsDetails" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/EntitlementSummaryCollection", "responses":{ "200":{ "description":"A page of permission objects.", "schema":{ "$ref":"#/definitions/EntitlementSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-permissions-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-permissions-post" } }, "/access-governance/access-reviews/20250331/campaigns/roles":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListRoles", "summary":"Get Roles", "description":"Retrieves a list of roles for running access reviews.\n", "parameters":[ { "$ref":"#/parameters/ListRolesDetails" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/RoleSummaryCollection", "responses":{ "200":{ "description":"A page of role summary objects.", "schema":{ "$ref":"#/definitions/RoleSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-roles-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-roles-post" } }, "/access-governance/access-reviews/20250331/campaigns/policies":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListPolicies", "summary":"Get Policies", "description":"Retrieves a list of policies for running policy reviews.", "parameters":[ { "$ref":"#/parameters/ListPoliciesDetails" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/PolicyCollection", "responses":{ "200":{ "description":"A page of policies objects.", "schema":{ "$ref":"#/definitions/PolicyCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-policies-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-policies-post" } }, "/access-governance/access-reviews/20250331/campaigns/identityCollections":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListIdentityCollections", "summary":"Get Identity Collections", "description":"Retrieves a list of identity collections for running membership review.", "parameters":[ { "$ref":"#/parameters/ListIdentityCollectionsDetails" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/IcCollection", "responses":{ "200":{ "description":"A page of identity collections objects.", "schema":{ "$ref":"#/definitions/IcCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-identityCollections-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-identitycollections-post" } }, "/access-governance/access-reviews/20250331/campaigns/cloudProviders":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListCloudProviders", "summary":"Get Cloud Providers", "description":"Returns a list of tenancies for a cloud system.", "parameters":[ { "$ref":"#/parameters/ListCloudProvidersDetails" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/CloudProviderCollection", "responses":{ "200":{ "description":"A page of cloud providers objects.", "schema":{ "$ref":"#/definitions/CloudProviderCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-cloudProviders-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-cloudproviders-post" } }, "/access-governance/access-reviews/20250331/campaigns/compartments":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListCompartments", "summary":"Get Compartments", "description":"Returns a list of compartments in a tenancy for a cloud system.", "parameters":[ { "$ref":"#/parameters/ListCompartmentsDetails" }, { "$ref":"#/parameters/PaginationExpandedLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/CompartmentCollection", "responses":{ "200":{ "description":"A page of compartment objects.", "schema":{ "$ref":"#/definitions/CompartmentCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-compartments-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-compartments-post" } }, "/access-governance/access-reviews/20250331/campaigns/domains":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListDomains", "summary":"Get Domains", "description":"Retrieves a list of domains associated with a tenancy in a specified compartment.", "parameters":[ { "$ref":"#/parameters/ListDomainsDetails" }, { "$ref":"#/parameters/PaginationExpandedLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/DomainCollection", "responses":{ "200":{ "description":"A page of domains objects.", "schema":{ "$ref":"#/definitions/DomainCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-domains-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-domains-post" } }, "/access-governance/access-reviews/20250331/campaigns/customAttributes/{customAttributeId}":{ "post":{ "tags":[ "Campaigns" ], "operationId":"ListCustomAttribute", "summary":"Get custom attributes values", "description":"Retrieve a list of custom attribute values applicable to 'Who has access?' when running Access Reviews.", "parameters":[ { "$ref":"#/parameters/CustomAttributeIdPathParam" }, { "$ref":"#/parameters/ListCustomAttributeDetails" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/SortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/CustomAttributeSummaryCollection", "responses":{ "200":{ "description":"A page of resource objects.", "schema":{ "$ref":"#/definitions/CustomAttributeSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-campaigns-customAttributes-{customAttributeId}-post", "x-filename-id":"access-governance-access-reviews-20250331-campaigns-customattributes-customattributeid-post" } }, "/access-governance/access-reviews/20250331/accessReviews/identity":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListIdentityAccessReviews", "summary":"Get a list of Identity Access Reviews", "description":"Returns details of all identity access reviews for a given user with support of pagination.\n", "parameters":[ { "$ref":"#/parameters/ListAccessReviewsUserIdQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/KeywordContainsQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/IdentityReviewSortByQueryParam" }, { "$ref":"#/parameters/ReviewSortByAttributeQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/IdentityAccessReviewSummaryCollection", "responses":{ "200":{ "description":"A page of ReviewTaskSummary objects.", "schema":{ "$ref":"#/definitions/IdentityAccessReviewSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-total-items":{ "description":"The total number of items.\n", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-identity-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-identity-get" } }, "/access-governance/access-reviews/20250331/accessReviews/accessControl":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListAccessControlAccessReviews", "summary":"Get a list of Access Control Access Reviews", "description":"Returns details of all access control access reviews for a given user with support of pagination.\n", "parameters":[ { "$ref":"#/parameters/ListAccessReviewsUserIdQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/KeywordContainsQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/AccessControlReviewSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessControlAccessReviewSummaryCollection", "responses":{ "200":{ "description":"A page of ReviewTaskSummary objects.", "schema":{ "$ref":"#/definitions/AccessControlAccessReviewSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-total-items":{ "description":"The total number of items.\n", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-accessControl-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accesscontrol-get" } }, "/access-governance/access-reviews/20250331/accessReviews/ownership":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListOwnershipAccessReviews", "summary":"Get a list of Ownership Access Reviews", "description":"Returns details of all ownership access reviews for a given user with support of pagination.\n", "parameters":[ { "$ref":"#/parameters/ListAccessReviewsUserIdQueryParam" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/KeywordContainsQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/OwnershipReviewSortByQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/OwnershipAccessReviewSummaryCollection", "responses":{ "200":{ "description":"A page of ReviewTaskSummary objects.", "schema":{ "$ref":"#/definitions/OwnershipAccessReviewSummaryCollection" }, "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-total-items":{ "description":"The total number of items.\n", "type":"integer" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-ownership-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-ownership-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"GetAccessReview", "summary":"Get details of an access review", "description":"Returns details of the access review for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessReview", "responses":{ "200":{ "description":"The access review.", "headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/AccessReview" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/insights":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"GetInsightsForAccessReview", "summary":"Get insights for an access review", "description":"Returns insights of the access review for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessReviewInsights", "responses":{ "200":{ "description":"The access review insights.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/AccessReviewInsights" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-insights-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-insights-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/eventChanges":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListEventChangesForAccessReview", "summary":"Get list of event changes for an access review", "description":"Returns list of event changes of the access review for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/EventChangeSortByQueryParam" } ], "x-related-resource":"#/definitions/AccessReviewEventChangesSummary", "responses":{ "200":{ "description":"The access review event changes.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/AccessReviewEventChangesSummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-eventChanges-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-eventchanges-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/priorActions":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListPriorActionsForAccessReview", "summary":"Get list of prior actions for an access review", "description":"Returns list of prior actions of the access review for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/PriorActionSortByQueryParam" } ], "x-related-resource":"#/definitions/AccessReviewPriorActionsSummary", "responses":{ "200":{ "description":"The access review prior actions.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/AccessReviewPriorActionsSummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-priorActions-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-prioractions-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/identities":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListIdentitiesForAccessReview", "summary":"Get list of identities for an Ownership or Identity collection access review based on ConditionType param", "description":"Returns list of identities for an Ownership or Identity collection access review.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/ConditionTypeQueryParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/IdentityReviewSortByQueryParam" } ], "x-related-resource":"#/definitions/IdentitySummary", "responses":{ "200":{ "description":"The access review included identities.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/IdentitySummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-identities-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-identities-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/membershipRules":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"GetMembershipRulesForAccessReview", "summary":"Get membership rules and excluded identities for Identity collection access review", "description":"Returns membership rules and excluded identities for Identity collection access review.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/MembershipRule", "responses":{ "200":{ "description":"The access review membership rules.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/MembershipRule" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-membershipRules-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-membershiprules-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/actionablePolicyStatements":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListActionablePolicyStatementsForAccessReview", "summary":"Get list of Actionable Policy Statements for an policy access review", "description":"Returns list of Actionable Policy Statements for an policy access review.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/PolicyStatementSortByQueryParam" } ], "x-related-resource":"#/definitions/PolicyStatementSummary", "responses":{ "200":{ "description":"The access review actionable policy statements.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/PolicyStatementSummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-actionablePolicyStatements-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-actionablepolicystatements-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/associations":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListAssociationsAccessReview", "summary":"Get list of Access Association for the given review task", "description":"Returns list of Access Association for the given access review.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/AssociationSortByQueryParam" } ], "x-related-resource":"#/definitions/AssociationSummary", "responses":{ "200":{ "description":"The access review associations.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/AssociationSummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-associations-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-associations-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/policyStatements/{policyStatementId}":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"GetPolicyStatement", "summary":"Get the policy statements details for the given policy statement ID for the policy access review", "description":"Returns policy statements details for the given policy statement ID for the policy access review.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/PolicyStatementIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/PolicyStatement", "responses":{ "200":{ "description":"The details of policy statement for given policy.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/PolicyStatement" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-policyStatements-{policyStatementId}-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-policystatements-policystatementid-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/policyStatements/{policyStatementId}/resourceCounts":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListPolicyStatementResourceCounts", "summary":"List resource counts summary of the policy statement", "description":"Returns resource counts summary of the policy statement for the policy access review.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/PolicyStatementIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/ResourceGroupByQueryParam" }, { "$ref":"#/parameters/ResourceDimensionTypeQueryParam" } ], "x-related-resource":"#/definitions/ResourceAggregationSummary", "responses":{ "200":{ "description":"The details of policy statement for given policy.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" } }, "schema":{ "$ref":"#/definitions/ResourceAggregationSummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-policyStatements-{policyStatementId}-resourceCounts-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-policystatements-policystatementid-resourcecounts-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/policyStatements/{policyStatementId}/resources":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListPolicyStatementResources", "summary":"List Policy statements resources for the given policy statement", "description":"Retrieves list of resources for the policy statement.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/PolicyStatementIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/PolicyResourceSortByQueryParam" } ], "x-related-resource":"#/definitions/PolicyStatementResourceSummary", "responses":{ "200":{ "description":"The details of policy statement for given policy.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-total-items":{ "description":"The total number of items.\n", "type":"integer" } }, "schema":{ "$ref":"#/definitions/PolicyStatementResourceSummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-policyStatements-{policyStatementId}-resources-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-policystatements-policystatementid-resources-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/policyStatements/{policyStatementId}/identities":{ "get":{ "tags":[ "AccessReviews" ], "operationId":"ListPolicyStatementIdentities", "summary":"List Policy statement identities for the given policy statement", "description":"Retrieves details of policy statement identities for the policy statement.", "parameters":[ { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/PolicyStatementIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/PaginationLimitQueryParam" }, { "$ref":"#/parameters/PaginationTokenQueryParam" }, { "$ref":"#/parameters/SortOrderQueryParam" }, { "$ref":"#/parameters/PolicyIdentitySortByQueryParam" } ], "x-related-resource":"#/definitions/PolicyStatementIdentitySummary", "responses":{ "200":{ "description":"The details of policy statement for given policy.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-total-items":{ "description":"The total number of items.\n", "type":"integer" } }, "schema":{ "$ref":"#/definitions/PolicyStatementIdentitySummaryCollection" } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-policyStatements-{policyStatementId}-identities-get", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-policystatements-policystatementid-identities-get" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/actions/accept":{ "post":{ "tags":[ "AccessReviews" ], "operationId":"AcceptAccessReview", "summary":"Accept an access review", "description":"Accepting the access review for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/AcceptAccessReviewDetails" }, { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" }, { "$ref":"#/parameters/IfMatchHeader" } ], "x-related-resource":"#/definitions/AccessReview", "responses":{ "202":{ "description":"Successfully submitted request to accept the access review.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-actions-accept-post", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-actions-accept-post" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/actions/revoke":{ "post":{ "tags":[ "AccessReviews" ], "operationId":"RevokeAccessReview", "summary":"Revoke an access review", "description":"Revoking the access review for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/RevokeAccessReviewDetails" }, { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessReview", "responses":{ "202":{ "description":"Successfully submitted request to revoke the access review.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-actions-revoke-post", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-actions-revoke-post" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/actions/modify":{ "post":{ "tags":[ "AccessReviews" ], "operationId":"ModifyAccessReview", "summary":"Modify an access review", "description":"Modifying the access review for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/ModifyAccessReviewDetails" }, { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessReview", "responses":{ "202":{ "description":"Successfully submitted request to modify the access review.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-actions-modify-post", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-actions-modify-post" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/actions/assign":{ "post":{ "tags":[ "AccessReviews" ], "operationId":"AssignAccessReview", "summary":"Assign an access review", "description":"Assigning ownership of an unmatched account to the identity id of the access review.", "parameters":[ { "$ref":"#/parameters/AssignAccessReviewDetails" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessReview", "responses":{ "202":{ "description":"Successfully submitted request to assign the access review.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-actions-assign-post", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-actions-assign-post" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/actions/remove":{ "post":{ "tags":[ "AccessReviews" ], "operationId":"RemoveAccessReview", "summary":"Remove an access review", "description":"Removing the unmatched account for the access review.", "parameters":[ { "$ref":"#/parameters/RemoveAccessReviewDetails" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessReview", "responses":{ "202":{ "description":"Successfully submitted request to remove assignment of the access review.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-actions-remove-post", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-actions-remove-post" } }, "/access-governance/access-reviews/20250331/accessReviews/{accessReviewId}/actions/reassign":{ "post":{ "tags":[ "AccessReviews" ], "operationId":"ReassignAccessReview", "summary":"Reassign an access review", "description":"Reassigning the access review to new reviewer(identityId) for a given accessReviewId.", "parameters":[ { "$ref":"#/parameters/ReassignAccessReviewDetails" }, { "$ref":"#/parameters/IfMatchHeader" }, { "$ref":"#/parameters/AccessReviewIdPathParam" }, { "$ref":"#/parameters/RequestIdHeader" } ], "x-related-resource":"#/definitions/AccessReview", "responses":{ "202":{ "description":"Successfully submitted request to Reassign the access review.", "headers":{ "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } } }, "400":{ "$ref":"#/responses/400" }, "401":{ "$ref":"#/responses/401" }, "404":{ "$ref":"#/responses/404" }, "412":{ "$ref":"#/responses/412" }, "429":{ "$ref":"#/responses/429" }, "500":{ "$ref":"#/responses/500" }, "default":{ "$ref":"#/responses/default" } }, "x-internal-id":"access-governance-access-reviews-20250331-accessReviews-{accessReviewId}-actions-reassign-post", "x-filename-id":"access-governance-access-reviews-20250331-accessreviews-accessreviewid-actions-reassign-post" } } }, "definitions":{ "Error":{ "required":[ "code", "message" ], "properties":{ "code":{ "type":"string", "description":"A short error code that defines the error, meant for programmatic parsing." }, "message":{ "type":"string", "description":"A human-readable error string." } }, "description":"Error Information." }, "EntityType":{ "type":"string", "description":"Entities within Access Governance", "enum":[ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ] }, "Reference":{ "type":"object", "required":[ "displayName", "entityType", "id" ], "properties":{ "id":{ "type":"string", "description":"The id for the Access Governance entity" }, "displayName":{ "type":"string", "description":"The Display name for the Access Governance entity" }, "entityType":{ "type":"string", "description":"A type describing the referred entity", "enum":[ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ], "x-obmcs-top-level-enum":"#/definitions/EntityType" } }, "description":"A reference" }, "LifecycleState":{ "type":"string", "description":"Possible lifecycle states.", "enum":[ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ] }, "SortOrders":{ "type":"string", "description":"Sort orders.", "enum":[ "ASC", "DESC" ] }, "Insight":{ "type":"object", "required":[ "version" ], "properties":{ "version":{ "type":"integer", "description":"The version of the insight format." }, "alignments":{ "type":"array", "description":"The list of alignment information.", "items":{ "$ref":"#/definitions/Alignment" } }, "insights":{ "type":"array", "description":"The list of insights.", "items":{ "$ref":"#/definitions/InsightAttribute" } }, "locationAlignments":{ "type":"array", "description":"The list of location alignment information.", "items":{ "$ref":"#/definitions/LocationAlignment" } }, "peerSimilarities":{ "type":"array", "description":"The list of peer similarities information.", "items":{ "$ref":"#/definitions/PeerSimilarity" } }, "identityCollectionMembership":{ "$ref":"#/definitions/IdentityCollectionMembership" } }, "description":"The insight information for the given Identity Collection." }, "AlignmentType":{ "type":"string", "description":"The type of the alignment.", "enum":[ "SAME_MANAGER", "SAME_JOB_CODE", "SAME_ORGANIZATION", "DIRECT_REPORT", "AG_ORGANIZATION" ] }, "InsightAttributeType":{ "type":"string", "description":"The type of the insight attribute.", "enum":[ "RECOMMENDATION", "ANALYSIS_RESULT", "RECENT_CHANGE" ] }, "ViolationType":{ "type":"string", "description":"The Access Governance Violation Types", "enum":[ "NO_VIOLATION", "LOW_RISK_ACCESS_GUARDRAIL_VIOLATION", "HIGH_RISK_ACCESS_GUARDRAIL_VIOLATION", "VIOLATION_NOT_AVAILABLE" ] }, "Alignment":{ "type":"object", "required":[ "type", "value" ], "properties":{ "type":{ "type":"string", "description":"The value of the alignment", "enum":[ "SAME_MANAGER", "SAME_JOB_CODE", "SAME_ORGANIZATION", "DIRECT_REPORT", "AG_ORGANIZATION" ], "x-obmcs-top-level-enum":"#/definitions/AlignmentType" }, "value":{ "type":"integer", "description":"The percentage value of the alignment" }, "name":{ "type":"string", "description":"The name associated with the alignment." } }, "description":"The alignment information for the given Identity Collection." }, "InsightAttribute":{ "type":"object", "required":[ "type", "value" ], "properties":{ "type":{ "type":"string", "description":"The type of the insight attribute", "enum":[ "RECOMMENDATION", "ANALYSIS_RESULT", "RECENT_CHANGE" ], "x-obmcs-top-level-enum":"#/definitions/InsightAttributeType" }, "value":{ "type":"string", "description":"The value of the insight attribute" }, "priority":{ "type":"integer", "description":"The priority of the insight attribute" } }, "description":"The insight attribute" }, "LocationAlignment":{ "type":"object", "required":[ "type" ], "properties":{ "type":{ "type":"string", "description":"The value of the alignment", "enum":[ "SAME_MANAGER", "SAME_JOB_CODE", "SAME_ORGANIZATION", "DIRECT_REPORT", "AG_ORGANIZATION" ], "x-obmcs-top-level-enum":"#/definitions/AlignmentType" }, "name":{ "type":"string", "description":"The name of the AG Organization that this new alignment score is for." }, "locationScores":{ "type":"array", "description":"The scores per location for this alignment type", "items":{ "$ref":"#/definitions/LocationScore" } } }, "description":"The alignment information for the given Identity Collection based on a location" }, "LocationScore":{ "type":"object", "required":[ "location", "matchedCount", "totalCount", "value" ], "properties":{ "location":{ "type":"string", "description":"The location for the score" }, "matchedCount":{ "type":"integer", "description":"The matched count of peers for the location" }, "totalCount":{ "type":"integer", "description":"The total count of peers for the location" }, "value":{ "type":"integer", "description":"The percentage value for the alignment score for the location" } }, "description":"The alignment score for the given location" }, "PeerSimilarity":{ "type":"object", "required":[ "similarities", "type" ], "properties":{ "type":{ "type":"string", "description":"The value of the alignment", "enum":[ "SAME_MANAGER", "SAME_JOB_CODE", "SAME_ORGANIZATION", "DIRECT_REPORT", "AG_ORGANIZATION" ], "x-obmcs-top-level-enum":"#/definitions/AlignmentType" }, "name":{ "type":"string", "description":"The name of the AG Organization that this new alignment score is for" }, "similarities":{ "type":"array", "description":"The list of similarities for this alignment type", "items":{ "$ref":"#/definitions/Similarity" } } }, "description":"The list of peer similarities information" }, "Similarity":{ "type":"object", "required":[ "individual", "location", "peerCount", "peers" ], "properties":{ "location":{ "type":"string", "description":"The location for the score" }, "individual":{ "type":"number", "format":"float", "description":"The percentage of individuals with similarity to their peers" }, "peers":{ "type":"number", "format":"float", "description":"The average similarity percentage of peers" }, "peerCount":{ "type":"integer", "description":"the count of the peers for the location" } }, "description":"The similarity information" }, "IdentityCollectionMembership":{ "type":"object", "required":[ "current", "expected" ], "properties":{ "current":{ "type":"integer", "description":"The current member count in the identity collection." }, "expected":{ "type":"integer", "description":"The expected member count in the identity collection." } }, "description":"The count for members in the identity collection." }, "AccessGovernanceTypeCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Access Governance Entity items.", "items":{ "$ref":"#/definitions/AccessGovernanceEntity" } } }, "description":"A list of Access Governance Entity items." }, "AccessGovernanceEntity":{ "type":"object", "required":[ "entityType", "id", "name", "timeCreated", "timeUpdated", "type", "value", "violationDetails" ], "properties":{ "id":{ "type":"string", "description":"The Id for Access Governance Entity" }, "type":{ "type":"string", "description":"The Access Governance Entity Type", "enum":[ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ], "x-obmcs-top-level-enum":"#/definitions/EntityType" }, "name":{ "type":"string", "description":"The name for Access Governance Type" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when entity was created by Access Governance" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when entity was last modified by Access Governance" }, "isRuleBased":{ "type":"boolean", "description":"Is this identity ruled based" }, "entityType":{ "type":"string", "description":"The Entity type in Access Governance" }, "value":{ "type":"string", "description":"The json schema for Access Governance Type" }, "violationDetails":{ "$ref":"#/definitions/ViolationDetails" } }, "description":"An Access Governance Entity" }, "ViolationDetails":{ "type":"object", "required":[ "accessGuardrailViolationId", "violationType" ], "properties":{ "violationType":{ "type":"string", "description":"The Violation type in Access Governance", "enum":[ "NO_VIOLATION", "LOW_RISK_ACCESS_GUARDRAIL_VIOLATION", "HIGH_RISK_ACCESS_GUARDRAIL_VIOLATION", "VIOLATION_NOT_AVAILABLE" ], "x-obmcs-top-level-enum":"#/definitions/ViolationType" }, "accessGuardrailViolationId":{ "type":"string", "description":"The access guardrail violation id" } }, "description":"The Violation details object" }, "IdentityReference":{ "type":"object", "required":[ "id", "name" ], "properties":{ "id":{ "type":"string", "description":"The Id for AG Identity" }, "name":{ "type":"string", "description":"The Display name AG Identity" } }, "description":"User details." }, "User":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Global id of the owner." }, "displayName":{ "type":"string", "description":"Display name of the owner." }, "isPrimary":{ "type":"boolean", "description":"Is user a primary owner." } }, "description":"Owner of a resource." }, "OwnerCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"Contains the list of owners.", "items":{ "$ref":"#/definitions/User" } } }, "description":"Contains the list of owners." }, "Info":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"id of the entity." }, "name":{ "type":"string", "description":"name of the entity." }, "displayName":{ "type":"string", "description":"Display Name of the entity." } }, "description":"Generic information object." }, "LabelValuePair":{ "type":"object", "required":[ "label", "value" ], "properties":{ "label":{ "type":"string", "description":"The label" }, "value":{ "type":"string", "description":"The value" } }, "description":"The label and value pair" }, "IdentityType":{ "type":"string", "description":"the possible identity types", "enum":[ "NONE", "ANY" ] }, "OrchestratedSystemSortBy":{ "type":"string", "description":"Field to sort by.", "enum":[ "timeCreated", "displayName" ] }, "OrchestratedSystemLifecycleState":{ "type":"string", "description":"Possible lifecycle states.", "enum":[ "ACTIVE", "INACTIVE" ] }, "OrchestratedSystemType":{ "type":"string", "description":"Possible data type for Orchestrated System parameter.", "enum":[ "OIG", "OCI", "AZUREAD", "DBUMORADB", "SALESFORCE", "SERVICENOW", "EBSUM", "EBSHRMS", "FA", "MSFTAD", "OID", "OUD", "DBUMMYSQL", "DBUMDB2", "MSTEAMS", "ELOQUA", "NETSUITE", "DBUMMSSQL", "EXPRESSFLATFILE", "GRC", "SIEBELUM", "PRIMAVERA", "PEOPLESOFT", "DBATORACLE", "ARCONPAM", "CERNERMILLENNIUM", "DBATMYSQL", "DBATMSSQL", "CERNERHI", "ZOOM", "JIRA", "WORKDAY", "SAPARIBA", "SUCCESSFACTORS", "SAPS4HANA", "SAPFIELDGLASS", "BEYONDTRUST", "ORACLEEPM", "SAPUM", "DBUMPOSTGRESQL", "AWS", "GOTOMEETING", "ORACLEAPEX", "ORACLECPQ", "ORACLEUNITY", "ORACLEOTMGTM", "ORACLEINFINITY", "WEBEX", "FALEARNING", "ORACLEWMS", "PANPRISMA", "GRCDIRECTCONFIG" ] }, "TemplateCategory":{ "type":"string", "description":"Possible template category.", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_SERVICE_PROVIDER", "DIRECTORY_INTEGRATIONS", "DATABASE_MANAGEMENT", "SAAS_APPLICATIONS", "ORACLE_APPLICATIONS", "EXPRESS" ] }, "OrchestratedSystemMode":{ "type":"string", "description":"Possible Orchestrated System modes.", "enum":[ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE", "SOURCE_OF_IDENTITY_ATTRIBUTE", "BOTH_SOURCE_OF_IDENTITY_ATTRIBUTE" ] }, "PermissionResourceType":{ "type":"string", "description":"Permission Resource Type for OCI systems.", "enum":[ "APP_ROLE", "GROUP" ] }, "AccountUpdateNotificationReceiver":{ "type":"string", "description":"Possible Notification Receivers for Account update.", "enum":[ "USER", "USER_MANAGER", "BOTH", "NONE" ] }, "AttributeAction":{ "type":"string", "description":"Possible Action on Entitlements.", "enum":[ "ADD", "UPDATE" ] }, "SeparationOfDutiesRequestStatus":{ "type":"string", "description":"Possible Request Status.", "enum":[ "SUCCESS", "FAILED", "IN_PROGRESS" ] }, "SeparationOfDutiesEventStatus":{ "type":"string", "description":"Possible Separation of Duties Event Status.", "enum":[ "SUCCESS", "FAILED", "IN_PROGRESS", "PENDING" ] }, "AggregatedOrchestratedSystemStatusError":{ "type":"object", "required":[ "action", "cause", "code", "message", "type" ], "properties":{ "code":{ "type":"string", "example":"", "description":"A short error code that defines the error, meant for programmatic parsing." }, "message":{ "type":"string", "example":"", "description":"A human-readable error string." }, "cause":{ "type":"string", "example":"", "description":"A cuase for the error." }, "action":{ "type":"string", "example":"", "description":"Recommended action to fix the error." }, "type":{ "type":"string", "example":"", "description":"Type of error." } }, "description":"Aggregate Orchestrated System Status Error Information." }, "ConnectionStatus":{ "type":"object", "required":[ "timeLastSuccessfulConnection" ], "properties":{ "timeLastSuccessfulConnection":{ "type":"string", "format":"date-time", "example":"2022-01-23T10:11:02.565+00:00", "description":"Time of last successful connection." }, "error":{ "$ref":"#/definitions/AggregatedOrchestratedSystemStatusError" } }, "description":"Status of the agent connection" }, "DataLoadStatus":{ "type":"object", "required":[ "timeLastSuccessfulDataLoad", "timeUpcomingDataLoad" ], "properties":{ "timeDataLoadStarted":{ "type":"string", "format":"date-time", "example":"2022-01-23T10:10:02.565+00:00", "description":"Time of start of data load." }, "timeLastSuccessfulDataLoad":{ "type":"string", "format":"date-time", "example":"2022-01-22T10:10:02.565+00:00", "description":"Time of last successful data load." }, "timeUpcomingDataLoad":{ "type":"string", "format":"date-time", "example":"2022-01-24T10:10:02.565+00:00", "description":"Time of upcoming successful data load." }, "error":{ "$ref":"#/definitions/AggregatedOrchestratedSystemStatusError" } }, "description":"Status of the data load" }, "AggregatedOrchestratedSystemStatus":{ "type":"object", "required":[ "dataLoadStatus" ], "properties":{ "aggregatedStatus":{ "type":"string", "example":"DATA_LOAD_INPROGRESS", "description":"Aggregated status of the Orchestrated System.", "enum":[ "ACTIVE", "DISABLED", "AGENT_NEVER_CONNECTED", "AGENT_DISCONNECTED", "AGENT_VERSION_MISMATCH", "TARGET_CONNECTION_FAILED", "TARGET_REFRESH_CONFIGURATION_FAILED", "TARGET_VALIDATION_FAILED", "DATA_LOAD_INPROGRESS", "DATA_LOAD_FAILED", "INGESTION_IN_PROGRESS", "INGESTION_FAILED", "LAST_LOAD_SUCCESS", "DATA_PROCESSING_IN_PROGRESS", "DATA_PROCESSING_FAILED", "DRAFT" ] }, "dataLoadStatus":{ "$ref":"#/definitions/DataLoadStatus" }, "connectionStatus":{ "$ref":"#/definitions/ConnectionStatus" } }, "description":"Status of the Orchestrated System." }, "OrchestratedSystemSummary":{ "type":"object", "required":[ "id", "lifecycleState", "type" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "name":{ "type":"string", "description":"A user-friendly Name provided while creation" }, "displayName":{ "type":"string", "description":"Orchestrated System Identifier, can be renamed." }, "lifecycleState":{ "type":"string", "description":"The current state of the Orchestrated System.", "enum":[ "ACTIVE", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemLifecycleState" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the Orchestrated System was created. An RFC3339 formatted datetime string.\n" }, "createdBy":{ "type":"string", "description":"A user identifier that created the Orchestrated System.", "minLength":0, "maxLength":255 }, "timeLastModified":{ "type":"string", "format":"date-time", "description":"The time the the Orchestrated System was last modified. An RFC3339 formatted datetime string.\n" }, "lastModifiedBy":{ "type":"string", "description":"A user identifier that last modified the Orchestrated System.", "minLength":0, "maxLength":255 }, "type":{ "type":"string", "description":"Possible type for the Orchestrated System.", "enum":[ "OIG", "OCI", "AZUREAD", "DBUMORADB", "SALESFORCE", "SERVICENOW", "EBSUM", "EBSHRMS", "FA", "MSFTAD", "OID", "OUD", "DBUMMYSQL", "DBUMDB2", "MSTEAMS", "ELOQUA", "NETSUITE", "DBUMMSSQL", "EXPRESSFLATFILE", "GRC", "SIEBELUM", "PRIMAVERA", "PEOPLESOFT", "DBATORACLE", "ARCONPAM", "CERNERMILLENNIUM", "DBATMYSQL", "DBATMSSQL", "CERNERHI", "ZOOM", "JIRA", "WORKDAY", "SAPARIBA", "SUCCESSFACTORS", "SAPS4HANA", "SAPFIELDGLASS", "BEYONDTRUST", "ORACLEEPM", "SAPUM", "DBUMPOSTGRESQL", "AWS", "GOTOMEETING", "ORACLEAPEX", "ORACLECPQ", "ORACLEUNITY", "ORACLEOTMGTM", "ORACLEINFINITY", "WEBEX", "FALEARNING", "ORACLEWMS", "PANPRISMA", "GRCDIRECTCONFIG" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemType" }, "category":{ "type":"string", "description":"Possible category of a Template.", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_SERVICE_PROVIDER", "DIRECTORY_INTEGRATIONS", "DATABASE_MANAGEMENT", "SAAS_APPLICATIONS", "ORACLE_APPLICATIONS", "EXPRESS" ], "x-obmcs-top-level-enum":"#/definitions/TemplateCategory" }, "mode":{ "type":"string", "description":"Mode of the Orchestrated System. It can support AUTHORITATIVE, NONAUTHORITATIVE or BOTH", "enum":[ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE", "SOURCE_OF_IDENTITY_ATTRIBUTE", "BOTH_SOURCE_OF_IDENTITY_ATTRIBUTE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemMode" } }, "description":"Summary of the Orchestrated System." }, "OrchestratedSystem":{ "type":"object", "required":[ "id", "lifecycleState", "type" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "name":{ "type":"string", "description":"A user-friendly Name provided while creation" }, "displayName":{ "type":"string", "description":"Orchestrated System Identifier, can be renamed." }, "lifecycleState":{ "type":"string", "description":"The current state of the Orchestrated System.", "enum":[ "ACTIVE", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemLifecycleState" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the Orchestrated System was created. An RFC3339 formatted datetime string.\n" }, "createdBy":{ "type":"string", "description":"A user identifier that created the Orchestrated System.", "minLength":0, "maxLength":255 }, "aggregatedOrchestratedSystemStatus":{ "$ref":"#/definitions/AggregatedOrchestratedSystemStatus" }, "timeLastModified":{ "type":"string", "format":"date-time", "description":"The time the the Orchestrated System was last modified. An RFC3339 formatted datetime string.\n" }, "lastModifiedBy":{ "type":"string", "description":"A user identifier that last modified the Orchestrated System.", "minLength":0, "maxLength":255 }, "type":{ "type":"string", "description":"Possible type for the Orchestrated System.", "enum":[ "OIG", "OCI", "AZUREAD", "DBUMORADB", "SALESFORCE", "SERVICENOW", "EBSUM", "EBSHRMS", "FA", "MSFTAD", "OID", "OUD", "DBUMMYSQL", "DBUMDB2", "MSTEAMS", "ELOQUA", "NETSUITE", "DBUMMSSQL", "EXPRESSFLATFILE", "GRC", "SIEBELUM", "PRIMAVERA", "PEOPLESOFT", "DBATORACLE", "ARCONPAM", "CERNERMILLENNIUM", "DBATMYSQL", "DBATMSSQL", "CERNERHI", "ZOOM", "JIRA", "WORKDAY", "SAPARIBA", "SUCCESSFACTORS", "SAPS4HANA", "SAPFIELDGLASS", "BEYONDTRUST", "ORACLEEPM", "SAPUM", "DBUMPOSTGRESQL", "AWS", "GOTOMEETING", "ORACLEAPEX", "ORACLECPQ", "ORACLEUNITY", "ORACLEOTMGTM", "ORACLEINFINITY", "WEBEX", "FALEARNING", "ORACLEWMS", "PANPRISMA", "GRCDIRECTCONFIG" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemType" }, "category":{ "type":"string", "description":"Possible category of a Template.", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_SERVICE_PROVIDER", "DIRECTORY_INTEGRATIONS", "DATABASE_MANAGEMENT", "SAAS_APPLICATIONS", "ORACLE_APPLICATIONS", "EXPRESS" ], "x-obmcs-top-level-enum":"#/definitions/TemplateCategory" }, "mode":{ "type":"string", "description":"Mode of the Orchestrated System. It can support AUTHORITATIVE, NONAUTHORITATIVE or BOTH", "enum":[ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE", "SOURCE_OF_IDENTITY_ATTRIBUTE", "BOTH_SOURCE_OF_IDENTITY_ATTRIBUTE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemMode" }, "primaryOwner":{ "$ref":"#/definitions/User" }, "domains":{ "$ref":"#/definitions/DomainCollection" }, "compartments":{ "$ref":"#/definitions/CompartmentCollection" }, "metaData":{ "$ref":"#/definitions/OrchestratedSystemMetaData" } }, "description":"Summary of the Orchestrated System." }, "OrchestratedSystemMetaData":{ "type":"object", "required":[ "canBeAuthoritative", "canBeOrchestratedSystem", "category", "isIdentityCollectionSupported", "isNonHumanIdentitySupported", "isOnpremAgentSupported", "isSchemaDiscoverySupported", "isSeparationOfDutiesSupported" ], "properties":{ "category":{ "type":"string", "description":"Possible category of a Template." }, "isOnpremAgentSupported":{ "type":"boolean", "example":true, "description":"Is on-prem agent supported." }, "canBeAuthoritative":{ "type":"boolean", "example":true, "description":"Orchestrated System can support Authoritative Entities." }, "canBeOrchestratedSystem":{ "type":"boolean", "example":true, "description":"Orchestrated System can support Orchestrated System Entities." }, "isNonHumanIdentitySupported":{ "type":"boolean", "example":true, "description":"Orchestrated System can support non-human identity." }, "isIdentityCollectionSupported":{ "type":"boolean", "example":true, "description":"Orchestrated System can support identity collection." }, "isSchemaDiscoverySupported":{ "type":"boolean", "example":true, "description":"Orchestrated System can support schema discovery." }, "isSeparationOfDutiesSupported":{ "type":"boolean", "example":false, "description":"Orchestrated System can support Separation of Duties operation." }, "notificationSettings":{ "$ref":"#/definitions/NotificationSettings" }, "leaverRequestType":{ "type":"string", "description":"Leaver request type." }, "moverRequestType":{ "type":"string", "description":"Mover request type." }, "accountUpdateEmailReceiver":{ "type":"string", "description":"Email notification receiver for account update.", "enum":[ "USER", "USER_MANAGER", "BOTH", "NONE" ], "x-obmcs-top-level-enum":"#/definitions/AccountUpdateNotificationReceiver" }, "canAgCreateNewAccounts":{ "type":"boolean", "example":true, "description":"Determines whether Access Governance is allowed to create new accounts." }, "canManageNonAgCreatedAccounts":{ "type":"boolean", "example":false, "description":"Specifies whether it can manage accounts that were not created by Access Governance." }, "ownershipCollectionId":{ "type":"string", "description":"Id of the ownership collection associated with the target." } }, "description":"Orchestrated System metadata." }, "NotificationSettings":{ "type":"object", "properties":{ "notificationUserCollection":{ "type":"array", "description":"List of ids of the users to be notified.", "items":{ "$ref":"#/definitions/NotificationUser" } }, "emailCollection":{ "type":"array", "description":"List of emails of the users to be notified.", "items":{ "type":"string" } } }, "description":"Setting to enable notification of target events to user" }, "NotificationUser":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Name of the user." }, "id":{ "type":"string", "description":"Global id of the user." }, "status":{ "type":"string", "description":"Status of the user." }, "subType":{ "type":"string", "description":"Sub-type of the user." } }, "description":"User to be notified." }, "OrchestratedSystemCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Orchestrated Systems.", "items":{ "$ref":"#/definitions/OrchestratedSystemSummary" } } }, "description":"Results of an Orchestrated System search. Contains both OrchestratedSystemSummary items and other data.\n" }, "NestedAttributes":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"Orchestrated System attributes", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeData" } } }, "description":"Nested set of Orchestrated System attributes" }, "OrchestratedSystemAttributeDataSummary":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Attribute name - Unique identifier" }, "title":{ "type":"string", "description":"Display Name for the attribute." }, "values":{ "type":"array", "description":"Attribute Values", "items":{ "type":"string" } }, "type":{ "type":"string", "description":"Type of attribute" }, "permissionType":{ "type":"string", "description":"Permission Type" }, "children":{ "type":"array", "description":"nested attributes", "items":{ "$ref":"#/definitions/NestedAttributesSummary" } }, "discriminator":{ "type":"string", "description":"this field signify attribute field is password" }, "isQuestion":{ "type":"boolean", "description":"Indicates if this Orchestrated System Attribute will be presented as a question." } }, "description":"Orchestrated System Attributes" }, "NestedAttributesSummary":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"Orchestrated System attributes", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary" } } }, "description":"Nested set of Orchestrated System attributes" }, "ValidationFormat":{ "type":"object", "properties":{ "uiErrorMsg":{ "type":"string", "description":"Localized Error Message" }, "uiErrorCode":{ "type":"string", "description":"Key to identify rule" }, "type":{ "type":"string", "description":"validation rule type" }, "rule":{ "type":"string", "description":"rule to apply" } }, "description":"Orchestrated System account attributes response" }, "PermissionCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of PermissionSummary", "items":{ "$ref":"#/definitions/PermissionSummary" } } }, "description":"Results of a Permission search. PermissionSummary items." }, "PermissionSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation" }, "name":{ "type":"string", "description":"Name of the permission" }, "description":{ "type":"string", "description":"Description of the permission" }, "type":{ "type":"string", "description":"Type of the permission" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the permission was last created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the permission was last updated. An RFC3339 formatted datetime string" }, "resource":{ "$ref":"#/definitions/ResourceSummary" }, "permissionType":{ "$ref":"#/definitions/PermissionTypeSummary" } }, "description":"Description of Permission." }, "ResourceSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "name":{ "type":"string", "description":"name of the Resource." }, "displayName":{ "type":"string", "description":"Display Name of the Resource." }, "type":{ "type":"string", "description":"Type of the Resource" }, "customAttributes":{ "type":"object", "description":"Metadata associated with the resource", "properties":{ } } }, "description":"Resource Summary." }, "PermissionTypeSummary":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "name":{ "type":"string", "description":"name of the PermissionType." }, "displayName":{ "type":"string", "description":"Display Name of the PermissionType." }, "externalId":{ "type":"string", "description":"External Id of the PermissionType" } }, "description":"PermissionType Summary." }, "OrchestratedSystemPermissionIdCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of permission ids.", "items":{ "$ref":"#/definitions/OrchestratedSystemPermissionId" } } }, "description":"A list of permission ids used to obtain a list of permission attributes." }, "OrchestratedSystemPermissionId":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Id of permission" } }, "description":"Id of permission" }, "OrchestratedSystemAttributes":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"collection of account & permission attributes", "items":{ "$ref":"#/definitions/OrchestratedSystemAttribute" } } }, "description":"The information about Orchestrated System attributes metadata" }, "OrchestratedSystemAttribute":{ "type":"object", "properties":{ "orchestratedSystem":{ "$ref":"#/definitions/Info" }, "accountAttributes":{ "type":"array", "description":"List of Orchestrated System account attributes", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeData" } }, "permissionAttributes":{ "type":"array", "description":"List of Orchestrated System permission attributes", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeData" } } }, "description":"Account & permission attributes" }, "OrchestratedSystemAttributeData":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Attribute name" }, "type":{ "type":"string", "description":"Type of attribute" }, "title":{ "type":"string", "description":"Display Name for the attribute." }, "description":{ "type":"string", "description":"A description of the attribute" }, "children":{ "type":"array", "description":"nested attributes", "items":{ "$ref":"#/definitions/NestedAttributes" } }, "lookupType":{ "type":"string", "description":"LookupID for the attribute" }, "defaultValues":{ "type":"array", "description":"Attribute Value", "items":{ "type":"string" } }, "permissionType":{ "type":"string", "description":"Permission Type" }, "discriminator":{ "type":"string", "description":"this field signify attribute field is password" } }, "description":"Orchestrated System Attributes" }, "LookupCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"collection of label and value", "items":{ "$ref":"#/definitions/LabelValuePair" } } }, "description":"The get data from the lookup table" }, "DomainCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of values.", "items":{ "$ref":"#/definitions/Domain" } } }, "description":"List of values (domains for OCI)." }, "Domain":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Id of the domain." }, "name":{ "type":"string", "description":"Name of the domain." }, "displayName":{ "type":"string", "description":"Display name of the domain." }, "description":{ "type":"string", "description":"Description of the domain." }, "compartmentId":{ "type":"string", "description":"Compartment id of which the domain is part of." } }, "description":"A domain for an OCI system." }, "CompartmentCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of compartment summaries", "items":{ "$ref":"#/definitions/CompartmentSummary" } } }, "description":"List of compartment" }, "CompartmentSummary":{ "type":"object", "required":[ "id", "name" ], "properties":{ "id":{ "type":"string", "description":"The ID of the compartment" }, "name":{ "type":"string", "description":"The name of the compartment" }, "fullName":{ "type":"string", "description":"The full path of the compartment" } }, "description":"The summary of compartment" }, "SeparationOfDutiesAnalysisDetails":{ "type":"object", "required":[ "permissionAssignments", "requestedBy" ], "properties":{ "orchestratedSystemIdentityId":{ "type":"string", "description":"The ID of the Identity on the Orchestrated System." }, "accountData":{ "$ref":"#/definitions/AccountData" }, "permissionAssignments":{ "type":"array", "description":"Permissions to be analyzed along with the account.", "items":{ "$ref":"#/definitions/AccountPermission" } }, "requestedBy":{ "type":"string", "description":"The user who requested the analysis." } }, "description":"Details for performing Separation of Duties analysis." }, "SeparationOfDutiesAnalysisResponseDetails":{ "type":"object", "required":[ "requestId", "status" ], "properties":{ "requestId":{ "type":"string", "description":"Unique perform analysis request identifier." }, "status":{ "type":"string", "description":"Request Status." } }, "description":"Response of the perform analysis request." }, "AccountData":{ "type":"object", "required":[ "attributes" ], "properties":{ "attributes":{ "type":"array", "description":"Account attributes.", "items":{ "$ref":"#/definitions/Attribute" } } }, "description":"Information about the user account." }, "Attribute":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Name of the attribute." }, "displayName":{ "type":"string", "description":"Display Name of the attribute." }, "value":{ "type":"array", "description":"Value of the attribute.", "items":{ "type":"string" } }, "action":{ "type":"string", "description":"Operation to be done on the attribute.", "enum":[ "ADD", "UPDATE" ], "x-obmcs-top-level-enum":"#/definitions/AttributeAction" }, "additionalAttributes":{ "type":"array", "description":"Additional attributes.", "items":{ "$ref":"#/definitions/AdditionalAttribute" } }, "attributes":{ "type":"array", "description":"Attributes.", "items":{ "$ref":"#/definitions/Attribute" } } }, "description":"Attribute of the account." }, "AdditionalAttribute":{ "type":"object", "required":[ "name", "value" ], "properties":{ "name":{ "type":"string", "description":"Name of the attribute." }, "value":{ "type":"array", "description":"Value of the attribute.", "items":{ "type":"string" } } }, "description":"Additional Attribute." }, "AccountPermission":{ "type":"object", "required":[ "action", "attributes", "id" ], "properties":{ "id":{ "type":"string", "description":"Permission ID." }, "action":{ "type":"string", "description":"Action on the permission.", "enum":[ "ADD", "UPDATE" ], "x-obmcs-top-level-enum":"#/definitions/AttributeAction" }, "attributes":{ "type":"array", "description":"Account attributes.", "items":{ "$ref":"#/definitions/Attribute" } } }, "description":"Permission to be scanned." }, "CheckSeparationOfDutiesStatus":{ "type":"object", "required":[ "requestIds" ], "properties":{ "requestIds":{ "type":"array", "description":"List of request IDs.", "items":{ "type":"string" } } }, "description":"Separation of Duties Analysis Request IDs." }, "CheckSeparationOfDutiesStatusDetails":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of request statuses.", "items":{ "$ref":"#/definitions/CheckSeparationOfDutiesRequestStatus" } } }, "description":"List of request statuses per Request ID." }, "CheckSeparationOfDutiesRequestStatus":{ "type":"object", "required":[ "events", "requestId", "requestStatus", "requestedBy" ], "properties":{ "requestId":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "requestStatus":{ "type":"string", "description":"Request Status.", "enum":[ "SUCCESS", "FAILED", "IN_PROGRESS" ], "x-obmcs-top-level-enum":"#/definitions/SeparationOfDutiesRequestStatus" }, "timeRequested":{ "type":"string", "format":"date-time", "description":"Request time." }, "timeRequestCompletion":{ "type":"string", "format":"date-time", "description":"Request Completion time." }, "requestedBy":{ "type":"string", "description":"Who or what made the request." }, "events":{ "type":"array", "description":"Separation of Duties Events.", "items":{ "$ref":"#/definitions/SeparationOfDutiesEvent" } } }, "description":"Request status." }, "SeparationOfDutiesEvent":{ "type":"object", "required":[ "createdBy", "hasViolation", "id", "provider", "requestPayload", "status", "violationSummary" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "status":{ "type":"string", "description":"Processing Status.", "enum":[ "SUCCESS", "FAILED", "IN_PROGRESS", "PENDING" ], "x-obmcs-top-level-enum":"#/definitions/SeparationOfDutiesEventStatus" }, "createdBy":{ "type":"string", "description":"Who or what created the event." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Creation time of the event." }, "timeProcessingStarted":{ "type":"string", "format":"date-time", "description":"Separation Of Duties processing start time." }, "timeProcessingEnded":{ "type":"string", "format":"date-time", "description":"Separation Of Duties processing end time." }, "requestPayload":{ "$ref":"#/definitions/RequestPayload" }, "hasViolation":{ "type":"boolean", "description":"Whether a violation was detected." }, "provider":{ "type":"string", "description":"Separation Of Duties provider." }, "violationSummary":{ "type":"array", "description":"Separation Of Duties Violation Summary.", "items":{ "$ref":"#/definitions/SeparationOfDutiesViolationSummary" } } }, "description":"Separation Of Duties Event." }, "RequestPayload":{ "type":"object", "properties":{ "requestData":{ "$ref":"#/definitions/SeparationOfDutiesAnalysisDetails" }, "userData":{ "$ref":"#/definitions/UserData" }, "accountData":{ "$ref":"#/definitions/AccountData" }, "childAssignmentData":{ "type":"array", "description":"List of child assignment data.", "items":{ "$ref":"#/definitions/ChildAssignmentData" } } }, "description":"Represents the payload for a request." }, "UserData":{ "type":"object", "required":[ "attributes" ], "properties":{ "attributes":{ "type":"array", "description":"User attributes.", "items":{ "$ref":"#/definitions/Attribute" } } }, "description":"Data of the User associated to a Separation of Duties event." }, "ChildAssignmentData":{ "type":"object", "required":[ "attributes" ], "properties":{ "attributes":{ "type":"array", "description":"Entitlement attributes.", "items":{ "$ref":"#/definitions/Attribute" } } }, "description":"Entitlement attributes." }, "SeparationOfDutiesViolationSummary":{ "type":"object", "properties":{ "controlName":{ "type":"string", "description":"Control name." }, "existingRoles":{ "type":"array", "description":"Roles already granted to an identity.", "items":{ "$ref":"#/definitions/RoleInfo" } }, "requestedRoles":{ "type":"array", "description":"Roles requested for an identity.", "items":{ "$ref":"#/definitions/RoleInfo" } } }, "description":"A Separation of Duties violation." }, "RoleInfo":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"The id of the role." }, "name":{ "type":"string", "description":"The name of the role." }, "displayName":{ "type":"string", "description":"The display name of the role." }, "accessPoints":{ "type":"array", "description":"Access points of the role.", "items":{ "type":"string" } } }, "description":"Identifying information for a role." }, "AccountProfile":{ "type":"object", "required":[ "description", "displayName", "id", "isDefault", "orchestratedSystemId" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "orchestratedSystemId":{ "type":"string", "description":"The orchestratedSystemId of the AccountProfile." }, "displayName":{ "type":"string", "description":"The display name of the AccountProfile." }, "description":{ "type":"string", "description":"The description of the AccountProfile." }, "tags":{ "type":"array", "description":"The list of tags associated with the AccountProfile.", "items":{ "type":"string" } }, "accountAttributes":{ "type":"array", "description":"List of account attributes", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary" } }, "accountUiAttributes":{ "type":"array", "description":"List of account attributes for UI rendering", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeData" } }, "isDefault":{ "type":"boolean", "description":"Indicates if this AccountProfile is the default for this service instance." }, "isInUseByAccessBundle":{ "type":"boolean", "description":"Indicates if this AccountProfile is the default for this service instance." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the AccountProfile was created. An RFC3339 formatted datetime string." }, "timeLastModified":{ "type":"string", "format":"date-time", "description":"The time the AccountProfile was last updated. An RFC3339 formatted datetime string." }, "createdBy":{ "$ref":"#/definitions/IdentityReference" }, "lastModifiedBy":{ "$ref":"#/definitions/IdentityReference" } }, "description":"The full set of data that makes up an AccountProfile." }, "AccountProfileSummary":{ "type":"object", "required":[ "displayName", "id", "isDefault", "lastModifiedBy", "timeLastModified" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation" }, "displayName":{ "type":"string", "description":"AccountProfile Identifier, can be renamed" }, "isDefault":{ "type":"boolean", "description":"Indicates if this AccountProfile is the default for this service instance." }, "timeLastModified":{ "type":"string", "format":"date-time", "description":"The time the AccountProfile was last updated. An RFC3339 formatted datetime string" }, "lastModifiedBy":{ "$ref":"#/definitions/IdentityReference" } }, "description":"Summary of the AccountProfile, used when returning lists." }, "AccountProfileCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of AccountProfileSummary items.", "items":{ "$ref":"#/definitions/AccountProfileSummary" } } }, "description":"Results of an AccountProfile search. Contains a list of AccountProfileSummary items." }, "AccountProfileSortBy":{ "type":"string", "description":"Field to sort by.", "enum":[ "timeCreated", "displayName", "timeLastModified" ] }, "OrganizationStatus":{ "type":"string", "description":"Organization status values.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ] }, "OrganizationSortBy":{ "type":"string", "description":"Field to sort by.", "enum":[ "createdBy", "displayName", "name", "timeUpdated" ] }, "OrganizationCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List containing summarized information about Organizations.", "items":{ "$ref":"#/definitions/OrganizationSummary" } } }, "description":"Contains summarized information about Organizations." }, "OrganizationSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "displayName":{ "type":"string", "description":"Display Name of the Organization." }, "name":{ "type":"string", "description":"Name of the Organization." }, "description":{ "type":"string", "description":"Description of the Organization." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Organization was created. An RFC3339 formatted datetime string." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Organization was last updated. An RFC3339 formatted datetime string." }, "organizationType":{ "type":"string", "description":"Type of the Organization." }, "createdBy":{ "$ref":"#/definitions/Info" }, "membershipRule":{ "type":"string", "description":"Membership Rule for the Organization." }, "status":{ "type":"string", "description":"Status of the Organization.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/OrganizationStatus", "x-default-description":"ACTIVE" }, "tags":{ "type":"array", "description":"List of tags attached to the Organization.", "items":{ "type":"string" } }, "primaryOwner":{ "$ref":"#/definitions/User" }, "isOwner":{ "type":"boolean", "description":"Boolean value checking if logged-in user is owner of this organization or not." } }, "description":"Summarized Organization model." }, "EntityStatus":{ "type":"string", "description":"Entity status values.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ] }, "SortByPm":{ "type":"string", "description":"Sort by options.", "enum":[ "name", "timeCreated", "timeUpdated" ] }, "SortByIdentity":{ "type":"string", "description":"Sort by options.", "enum":[ "timeCreated", "timeUpdated", "username", "displayName" ] }, "RequestableBy":{ "type":"string", "description":"Whether the resource can be requested (anyone, or no one)", "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ] }, "RequestStatus":{ "type":"string", "description":"Possible approval process instance statuses.", "enum":[ "PENDING_APPROVALS", "INFO_REQUESTED", "APPROVED", "REJECTED", "DELETED", "FAILED", "CANCELLED", "PENDING_SOD", "PROVISIONED", "PROVISIONING_IN_PROGRESS", "PROVISIONING_FAILED" ] }, "RequestSortBy":{ "type":"string", "description":"Possible Sorting parameter values for my requests api.", "enum":[ "requestor", "beneficiary", "status", "timeCreated", "assignmentName", "assignmentType" ] }, "Status":{ "type":"string", "description":"Status values.", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ] }, "OwnerSummary":{ "type":"object", "required":[ "id", "isPrimary", "name" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation" }, "name":{ "type":"string", "description":"Name of the owner" }, "isPrimary":{ "type":"boolean", "description":"Is this entity the primary owner?" } }, "description":"Owner entity object" }, "SourceEntityTypes":{ "type":"string", "description":"The Access Governance Source Entity Types", "enum":[ "IDENTITY_GROUP", "GROUP" ] }, "OrchestratedSystemMetadataAttributes":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"id of target." }, "label":{ "type":"string", "description":"label of target." }, "attributes":{ "$ref":"#/definitions/OrchestratedSystemAttributes" } }, "description":"Orchestrated System Metadata Attributes model." }, "AGRiskModel":{ "type":"object", "required":[ "value" ], "properties":{ "value":{ "type":"integer", "description":"riskLevel of Access Governance Entity" }, "description":{ "type":"string", "description":"The description of riskLevel of Access Governance Entity" }, "customAttributes":{ "type":"object", "description":"Metadata associated with the riskLevel of Access Governance Entity", "properties":{ } } }, "description":"The riskLevel holder for Access Governance Entity" }, "AccessGuardrailDetails":{ "type":"object", "required":[ "id", "name" ], "properties":{ "id":{ "type":"string", "description":"The access guardrail id." }, "name":{ "type":"string", "description":"The access guardrail name." } }, "description":"Access Guardrail object." }, "RevisionStatus":{ "type":"string", "description":"Revision status", "enum":[ "NONE", "DRAFT", "REVISION_REQUESTED", "DELETE_REQUESTED", "CANCELED", "APPROVED", "REJECTED", "DELETE_REJECTED", "FAILED", "INFO_REQUESTED" ] }, "AccessBundleSortBy":{ "type":"string", "description":"Access Bundle sort by fields.", "enum":[ "name", "timeUpdated", "createdBy" ] }, "AccessBundleTimeLimitType":{ "type":"string", "description":"Access Time Limit Type.", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS" ] }, "AccessBundleCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Access Bundle summaries.", "items":{ "$ref":"#/definitions/AccessBundleSummary" } } }, "description":"Results of an Access Bundle list request." }, "AccessBundleSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation by the system." }, "name":{ "type":"string", "description":"Access Bundle name." }, "description":{ "type":"string", "description":"Access Bundle description." }, "tags":{ "type":"array", "description":"List of tags attached to the Access Bundle.", "items":{ "type":"string" } }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Access Bundle was created. An RFC3339 formatted datetime string." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Access Bundle was last updated. An RFC3339 formatted datetime string." }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "requestableBy":{ "type":"string", "description":"The identity type that may request the Access Bundle.", "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy" }, "status":{ "type":"string", "description":"Status of the Access Bundle.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "approvalWorkflowId":{ "type":"string", "description":"The id of the approval workflow that is applicable to the Access Bundle." }, "orchestratedSystem":{ "$ref":"#/definitions/IdInfo" }, "primaryOwner":{ "$ref":"#/definitions/PrimaryOwner" }, "isOwner":{ "type":"boolean", "description":"True if the identity of the caller is the owner of the Access Bundle." }, "customAttributes":{ "type":"object", "description":"Custom attributes associated with the Access Bundle.", "properties":{ } }, "accessTimeLimitType":{ "type":"string", "description":"Time limit type of the access bundle.", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS" ], "x-obmcs-top-level-enum":"#/definitions/AccessBundleTimeLimitType", "x-default-description":"INDEFINITELY" }, "accessTimeLimit":{ "$ref":"#/definitions/AccessBundleTimeLimit" }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Access Bundle.", "items":{ "$ref":"#/definitions/IdInfo" } } }, "description":"Access Bundle summary object." }, "AccessBundle":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "name":{ "type":"string", "description":"Name of the Access Bundle." }, "displayName":{ "type":"string", "description":"Display Name of the Access Bundle." }, "description":{ "type":"string", "description":"Description of the Access Bundle." }, "tags":{ "type":"array", "description":"List of tags attached to the Access Bundle.", "items":{ "type":"string" } }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Access Bundle was created. An RFC3339 formatted datetime string." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Access Bundle was last updated. An RFC3339 formatted datetime string." }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "updatedBy":{ "$ref":"#/definitions/IdInfo" }, "requestableBy":{ "$ref":"#/definitions/IdInfo" }, "status":{ "type":"string", "description":"Status of the Access Bundle.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "approvalWorkflowId":{ "$ref":"#/definitions/IdInfo" }, "orchestratedSystem":{ "$ref":"#/definitions/IdInfo" }, "orchestratedSystemType":{ "type":"string", "description":"Orchestrated System type." }, "ownershipCollectionId":{ "type":"string", "description":"Ownership collection associated with the Access Bundle." }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "externalId":{ "type":"string", "description":"ExternalId of the Access Bundle." }, "cloudAccountName":{ "type":"string", "description":"Cloud Account name of OCI bundle i.e., OCI tenancy." }, "domainName":{ "type":"string", "description":"Domain name of OCI bundle." }, "resourceType":{ "type":"string", "description":"Resource Type of an OCI Access Bundle." }, "compartmentName":{ "type":"string", "description":"Compartment name of OCI bundle." }, "compartmentFqn":{ "type":"string", "description":"Compartment full name of OCI bundle." }, "orchestratedSystemAttributes":{ "$ref":"#/definitions/OrchestratedSystemAttributeSummary" }, "accountProfileId":{ "type":"string", "description":"Configured account profile id for the access bundle." }, "accountProfileName":{ "type":"string", "description":"configured account profile name for the access bundle." }, "customAttributes":{ "type":"object", "description":"Metadata associated with the access bundle.", "properties":{ } }, "accessGuardrail":{ "$ref":"#/definitions/AccessGuardrailDetails" }, "permissions":{ "type":"array", "description":"List of permissions", "items":{ "$ref":"#/definitions/PermissionSummary" } }, "autoApproveIfNoViolation":{ "type":"boolean", "description":"Boolean flag to indicate auto approve if no violation in access request to the Access Bundle." }, "accessTimeLimitType":{ "type":"string", "description":"Time limit type of the access bundle.", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS" ], "x-obmcs-top-level-enum":"#/definitions/AccessBundleTimeLimitType", "x-default-description":"INDEFINITELY" }, "accessTimeLimit":{ "$ref":"#/definitions/AccessBundleTimeLimit" }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Access Bundle.", "items":{ "$ref":"#/definitions/IdInfo" } } }, "description":"Access Bundle object." }, "IdInfo":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Id of the entity." }, "name":{ "type":"string", "description":"Name of the entity." }, "displayName":{ "type":"string", "description":"Display Name of the entity." } }, "description":"Generic identifying information object." }, "PrimaryOwner":{ "type":"object", "properties":{ "value":{ "type":"string", "description":"Id of the primary Owner." }, "displayName":{ "type":"string", "description":"Display name of the primary Owner." } }, "description":"Details of a primary Owner." }, "CreateAccessBundleDetails":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Access Bundle Identifier.", "minLength":1, "maxLength":255 }, "displayName":{ "type":"string", "description":"displayName of the Access Bundle." }, "description":{ "type":"string", "description":"Access Bundle description." }, "tags":{ "type":"array", "description":"List of tags attached to the Access Bundle.", "items":{ "type":"string" } }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "requestableBy":{ "type":"string", "description":"Entities that can request the access bundle.", "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy" }, "approvalWorkflowId":{ "type":"string", "description":"ApprovalWorkflowId that is applicable to the Access Bundle." }, "orchestratedSystemId":{ "type":"string", "description":"Orchestrated System Identifier that the Access Bundle is associated with." }, "verb":{ "type":"string", "description":"Access to be given to the resource bundle." }, "externalId":{ "type":"string", "description":"externalId of the Access Bundle." }, "domainName":{ "type":"string", "description":"Domain name of an OCI Access Bundle." }, "resourceType":{ "type":"string", "description":"Resource Type of an OCI Access Bundle." }, "accountProfileId":{ "type":"string", "description":"Configured account profile id for the access bundle." }, "accountProfileName":{ "type":"string", "description":"Configured account profile name for the access bundle." }, "orchestratedSystemAttributes":{ "$ref":"#/definitions/OrchestratedSystemAttributeSummary" }, "customAttributes":{ "type":"object", "description":"Metadata associated with the access bundle.", "properties":{ } }, "accessGuardrail":{ "type":"string", "description":"Access guardrail attached to the Access Bundle." }, "autoApproveIfNoViolation":{ "type":"boolean", "description":"Boolean flag to indicate auto approve if no violation in access request to the Access Bundle." }, "accessTimeLimitType":{ "type":"string", "description":"Time limit type of the access bundle.", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS" ], "x-obmcs-top-level-enum":"#/definitions/AccessBundleTimeLimitType", "x-default-description":"INDEFINITELY" }, "accessTimeLimit":{ "$ref":"#/definitions/AccessBundleTimeLimit" }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Access Bundle.", "items":{ "$ref":"#/definitions/Info" } } }, "description":"The information about new Access Bundle." }, "UpdateAccessBundleDetails":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Access Bundle name.", "minLength":1, "maxLength":255 }, "description":{ "type":"string", "description":"Access Bundle description." }, "requestableBy":{ "type":"string", "description":"Entities that can request the access bundle.", "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy" }, "approvalWorkflowId":{ "type":"string", "description":"ApprovalWorkflowId that is applicable to the Access Bundle." }, "orchestratedSystemId":{ "type":"string", "description":"Orchestrated System Identifier that the Access Bundle is associated with." }, "tags":{ "type":"array", "description":"List of tags attached to the Access Bundle.", "items":{ "type":"string" } }, "verb":{ "type":"string", "description":"Access to be given to the resource bundle." }, "externalId":{ "type":"string", "description":"externalId of the Access Bundle." }, "displayName":{ "type":"string", "description":"displayName of the Access Bundle." }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "domainName":{ "type":"string", "description":"Domain name of an OCI Access Bundle." }, "resourceType":{ "type":"string", "description":"Resource Type of an OCI Access Bundle." }, "accountProfileId":{ "type":"string", "description":"Configured account profile id for the access bundle." }, "accountProfileName":{ "type":"string", "description":"Configured account profile name for the access bundle." }, "orchestratedSystemAttributes":{ "$ref":"#/definitions/OrchestratedSystemAttributeSummary" }, "customAttributes":{ "type":"object", "description":"Metadata associated with the access bundle.", "properties":{ } }, "accessGuardrail":{ "type":"string", "description":"Access guardrail attached to the Access Bundle." }, "autoApproveIfNoViolation":{ "type":"boolean", "description":"Boolean flag to indicate auto approve if no violation in access request to the Access Bundle." }, "accessTimeLimitType":{ "type":"string", "description":"Time limit type of the access bundle. When anything other than INDEFINITELY, accessTimeLimit must be provided.", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS" ], "x-obmcs-top-level-enum":"#/definitions/AccessBundleTimeLimitType", "x-default-description":"INDEFINITELY" }, "accessTimeLimit":{ "$ref":"#/definitions/AccessBundleTimeLimit" }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Access Bundle.", "items":{ "$ref":"#/definitions/Info" } } }, "description":"The information to be updated." }, "OrchestratedSystemAttributeSummary":{ "type":"object", "properties":{ "accountAttributes":{ "type":"array", "description":"List of Orchestrated System account attributes.", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary" } }, "permissionAttributes":{ "type":"array", "description":"List of Orchestrated System permission attributes.", "items":{ "$ref":"#/definitions/OrchestratedSystemAttributeDataSummary" } } }, "description":"Account & permission attributes." }, "AccessBundleTimeLimit":{ "type":"object", "properties":{ "daysLimit":{ "$ref":"#/definitions/AccessBundleTimeLimitDays" }, "hoursLimit":{ "$ref":"#/definitions/AccessBundleTimeLimitHours" } }, "description":"Time limit definition. Only one of daysLimit, hoursLimit, or dateTimeLimit should be specified.\n" }, "AccessBundleTimeLimitDays":{ "type":"object", "required":[ "accessLimitInDays", "extensionApprovalWorkflowId", "extensionInDays", "notificationInDays" ], "properties":{ "accessLimitInDays":{ "type":"integer", "description":"Maximum number of days allowed before expiry.", "minimum":1, "maximum":365 }, "notificationInDays":{ "type":"integer", "description":"Number of days when notification should be sent.", "minimum":1, "maximum":30 }, "extensionInDays":{ "type":"integer", "description":"Number of days extensions is allowed.", "minimum":1, "maximum":90 }, "extensionApprovalWorkflowId":{ "$ref":"#/definitions/IdInfo" } }, "description":"Time limit definition in days." }, "AccessBundleTimeLimitHours":{ "type":"object", "required":[ "accessLimitInHours", "extensionApprovalWorkflowId", "extensionInHours", "notificationInHours" ], "properties":{ "accessLimitInHours":{ "type":"integer", "description":"Maximum number of hours allowed before expiry.", "minimum":1, "maximum":24 }, "notificationInHours":{ "type":"integer", "description":"Number of hours when notification should be sent.", "minimum":1, "maximum":24 }, "extensionInHours":{ "type":"integer", "description":"Number of hours extension is allowed.", "minimum":1, "maximum":8 }, "extensionApprovalWorkflowId":{ "$ref":"#/definitions/IdInfo" } }, "description":"Time limit definition in hours." }, "PermissionType":{ "type":"string", "description":"Permission type.", "enum":[ "PERMISSION", "ACCESS_BUNDLE", "ROLE" ] }, "RevokePermissionDetails":{ "type":"object", "required":[ "globalId", "permissionType" ], "properties":{ "globalId":{ "type":"string", "description":"The global identity of the user for which to revoke the granted permission." }, "permissionType":{ "type":"string", "description":"The permission type to revoke.", "enum":[ "PERMISSION", "ACCESS_BUNDLE", "ROLE" ], "x-obmcs-top-level-enum":"#/definitions/PermissionType" } }, "description":"Permission revocation details." }, "RevokePermissionStatus":{ "type":"object", "required":[ "globalId", "status" ], "properties":{ "globalId":{ "type":"string", "description":"The global identity of the user." }, "status":{ "type":"string", "description":"The status of the request." } }, "description":"Permission revocation summary." }, "ApprovalProcessOutOfBoxCategory":{ "type":"string", "description":"Indication of the type of out of box workflow to filter on.", "enum":[ "UNMATCHED", "OWNERSHIP", "TRANSITION" ] }, "ApprovalProcessState":{ "type":"string", "description":"Possible lifecycle states.", "enum":[ "DRAFT", "PUBLISHING", "ACTIVE", "DISABLED", "DELETING" ] }, "ApprovalProcessSortBy":{ "type":"string", "description":"Approval Process sort by fields.", "enum":[ "displayName", "state", "creatorId", "timeCreated" ] }, "ApprovalProcessOwner":{ "type":"object", "required":[ "displayName", "id", "isPrimary" ], "properties":{ "id":{ "type":"string", "description":"User ID of the identity.", "minLength":1, "maxLength":255 }, "displayName":{ "type":"string", "description":"The display name of the identity." }, "isPrimary":{ "type":"boolean", "description":"Set to true if the user is the primary owner, set to false otherwise." } }, "description":"Details of an approval process owner." }, "ApprovalProcessCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of approval process summaries.", "items":{ "$ref":"#/definitions/ApprovalProcessSummary" } } }, "description":"Results of a approval process search." }, "ApprovalProcessSummary":{ "type":"object", "required":[ "creatorId", "displayName", "guid", "isInDraftMode", "state", "timeCreated", "timeUpdated", "updaterId" ], "properties":{ "guid":{ "type":"string", "description":"The global identifier for the approval process definition." }, "version":{ "type":"integer", "description":"The version of the approval process definition." }, "displayName":{ "type":"string", "description":"The approval process name, must be unique.", "minLength":1, "maxLength":100 }, "state":{ "type":"string", "description":"The lifecycle state of the approval process.", "enum":[ "DRAFT", "PUBLISHING", "ACTIVE", "DISABLED", "DELETING" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessState" }, "isInDraftMode":{ "type":"boolean", "description":"Indicates whether a draft for the approval process is available." }, "creatorId":{ "type":"string", "description":"The ID of the creator." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time that the approval process was created." }, "updaterId":{ "type":"string", "description":"User ID of last person that updated the process." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The last update date of the process." }, "isRuntime":{ "type":"boolean", "description":"Set to true if the approval process has configuration provided at runtime." }, "isDefault":{ "type":"boolean", "description":"Set to true if the approval process is the default process." }, "ownershipCollectionId":{ "type":"string", "description":"The ownership collection ID" }, "ownedEntityId":{ "type":"string", "description":"The ownership collection owned entity ID" }, "owner":{ "$ref":"#/definitions/ApprovalProcessOwner" } }, "description":"Summary of the AgcsApprovalProcess." }, "AssignmentType":{ "type":"string", "description":"Defines type of the assignment - access bundle or role", "enum":[ "ACCESS_BUNDLE", "ROLE", "IDENTITY_GROUP", "ACTIVE_GROUP", "CONSUMER_GROUP", "AG_ORGANIZATION" ] }, "RequestType":{ "type":"string", "description":"Defines if the request is associated with workflow or wothout workflow.", "enum":[ "WORKFLOW", "NO_WORKFLOW" ] }, "AccessLimitType":{ "type":"string", "description":"Access Limit Type", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS", "DATE_TIME_RANGE" ] }, "AccessBundleInfo":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"id of the entity." }, "name":{ "type":"string", "description":"name of the entity." }, "displayName":{ "type":"string", "description":"display name of the entity" }, "accountProfileId":{ "type":"string", "description":"account profile id" } }, "description":"Generic information object." }, "IdentityAccountAttributesInfo":{ "type":"object", "properties":{ "identityId":{ "type":"string", "description":"Global Identity Id" }, "accountAttributes":{ "type":"array", "description":"Account Attribute Values", "items":{ "$ref":"#/definitions/QuestionAttributeDataSummary" } } }, "description":"Account Profile Attributes" }, "AccountProfileInfo":{ "type":"object", "properties":{ "accountProfileId":{ "type":"string", "description":"Account Profile Id" }, "identitySpecific":{ "type":"boolean", "description":"Same configuration for all identities." }, "identityAccountAttributesDetails":{ "type":"array", "description":"Account Attributes Info by Identity", "items":{ "$ref":"#/definitions/IdentityAccountAttributesInfo" } }, "accountAttributes":{ "type":"array", "description":"Account Attribute Values", "items":{ "$ref":"#/definitions/QuestionAttributeDataSummary" } } }, "description":"Account Profile Configuration by Identity" }, "AccessRequestPrecheckResult":{ "type":"object", "required":[ "accessGuardrailViolations", "separationOfDutiesAnalysisRequests" ], "properties":{ "accessGuardrailViolations":{ "$ref":"#/definitions/AccessGuardrailViolationCollection" }, "separationOfDutiesAnalysisRequests":{ "$ref":"#/definitions/SeparationOfDutiesRequestCollection" } }, "description":"Results of running access guardrails & separation of duties analysis for an access request, without creating the access request.\n" }, "AccessGuardrailViolationCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of access guardrail violation details.", "items":{ "$ref":"#/definitions/AccessGuardrailViolationSummary" } } }, "description":"Collection of access guardrail violations." }, "AccessGuardrailViolationSummary":{ "type":"object", "properties":{ "accessGuardrailId":{ "type":"string", "description":"Id of the access guardrail associated to an Access Bundle." }, "accessGuardrailName":{ "type":"string", "description":"Name of the access guardrail associated to an Access Bundle." }, "violationDetails":{ "type":"object", "description":"A map where keys represent global identities and values are lists of violations in strings.", "additionalProperties":{ "type":"array", "items":{ "type":"string" } } } }, "description":"Access Guardrail violation summary." }, "SeparationOfDutiesRequestCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of separation of duties request summaries.", "items":{ "$ref":"#/definitions/SeparationOfDutiesRequestSummary" } } }, "description":"A collection of separation of duties request summaries." }, "SeparationOfDutiesRequestSummary":{ "type":"object", "required":[ "requestId", "status" ], "properties":{ "requestId":{ "type":"string", "description":"A string representing a separation of duties work request. Get updates on the status of a request by\nusing the 'Check status of the separation of duties request(s)' endpoint.\n" }, "status":{ "type":"string", "description":"The status of the separation of duties work request." } }, "description":"A summary for a separation of duties request." }, "CreateAccessRequestDetails":{ "type":"object", "properties":{ "justification":{ "type":"string", "description":"Justification for creating the access request" }, "requestStatus":{ "type":"string", "description":"Status of the access request" }, "permissionRoles":{ "type":"array", "description":"list of Permission roles items.", "items":{ "type":"string" } }, "accessBundles":{ "type":"array", "description":"list of Access bundle items.", "items":{ "type":"string" } }, "identities":{ "type":"array", "description":"list of identity ids", "items":{ "type":"string" } }, "orchestratedSystemAttributes":{ "type":"array", "description":"list of orchestratedSystemAttributes associated with targets", "items":{ "$ref":"#/definitions/OrchestratedSystemAttribute" } }, "accountProfileDetails":{ "type":"array", "description":"List of account profiles associated to access request. Required only if the associated access bundle has Account Profile attached to it.", "items":{ "$ref":"#/definitions/AccountProfileInfo" } }, "attributes":{ "type":"object", "description":"Attributes of the corresponding model. \nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "additionalProperties":{ "type":"object", "properties":{ } } }, "accessLimitDataDetails":{ "type":"array", "description":"List of access limit data associated to permission request", "items":{ "$ref":"#/definitions/AccessLimitDataDetails" } } }, "description":"The information about new AccessRequest." }, "AccessLimitDataDetails":{ "type":"object", "properties":{ "accessBundleId":{ "type":"string", "description":"Access bundle Id" }, "isIdentitySpecific":{ "type":"boolean", "description":"Same configuration for all identities." }, "identityAccessLimitDetails":{ "type":"array", "description":"Access Limit Data for Identity", "items":{ "$ref":"#/definitions/IdentityAccessLimitDataInfo" } }, "accessLimitDataInfo":{ "$ref":"#/definitions/AccessLimitDataInfo" } }, "description":"Access Limit Data configured by Identity" }, "IdentityAccessLimitDataInfo":{ "type":"object", "properties":{ "identityId":{ "type":"string", "description":"Global Identity Id" }, "accessLimitDataInfo":{ "$ref":"#/definitions/AccessLimitDataInfo" } }, "description":"Access Limit Data for Identity" }, "AccessLimitDataInfo":{ "type":"object", "properties":{ "accessLimitType":{ "type":"string", "description":"Time limit type of the access bundle", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS", "DATE_TIME_RANGE" ], "x-obmcs-top-level-enum":"#/definitions/AccessLimitType", "x-default-description":"INDEFINITELY" }, "accessLimitData":{ "$ref":"#/definitions/AccessLimitData" } }, "description":"Access Limit Data information object." }, "AccessLimitData":{ "type":"object", "properties":{ "daysConfig":{ "$ref":"#/definitions/AccessLimitDaysConfig" }, "hoursConfig":{ "$ref":"#/definitions/AccessLimitHoursConfig" }, "dateTimeConfig":{ "$ref":"#/definitions/AccessLimitDateTimeConfig" } }, "description":"The Temporal Access Bundle data." }, "AccessLimitDaysConfig":{ "type":"object", "properties":{ "expirationInDays":{ "type":"integer", "description":"Maximum number of days allowed before expiry" }, "notificationInDays":{ "type":"integer", "description":"Number of days when notification should be sent" }, "extensionInDays":{ "type":"integer", "description":"Number of days extensions is allowed" }, "extensionApprovalWorkflowId":{ "$ref":"#/definitions/IdInfo" } }, "description":"The Temporal Access Bundle data for days." }, "AccessLimitHoursConfig":{ "type":"object", "properties":{ "expirationInHours":{ "type":"integer", "description":"Maximum number of hours allowed before expiry" }, "notificationInHours":{ "type":"integer", "description":"Number of hours when notification should be sent" }, "extensionInHours":{ "type":"integer", "description":"Number of hours extensions is allowed" }, "extensionApprovalWorkflowId":{ "$ref":"#/definitions/IdInfo" } }, "description":"The Temporal Access Bundle data for hours." }, "AccessLimitDateTimeConfig":{ "type":"object", "properties":{ "expirationStartTime":{ "type":"integer", "format":"int64", "description":"Time in epoch when the access should be granted" }, "expirationEndTime":{ "type":"integer", "format":"int64", "description":"Time in epoch when the access should be expired" } }, "description":"The Temporal Access Bundle data for date time." }, "AccessRequest":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "justification":{ "type":"string", "description":"Justification for creating or updating the access request" }, "requestStatus":{ "type":"string", "description":"Status of the access request" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the the AccessRequest was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The time the the AccessRequest was last updated. An RFC3339 formatted datetime string" }, "createdBy":{ "type":"string", "description":"The user that created the request" }, "permissionRoles":{ "type":"array", "description":"list of Permission roles items.", "items":{ "$ref":"#/definitions/Info" } }, "accessBundles":{ "type":"array", "description":"list of Access bundle items.", "items":{ "$ref":"#/definitions/AccessBundleInfo" } }, "identities":{ "type":"array", "description":"list of identities", "items":{ "$ref":"#/definitions/Info" } }, "attributes":{ "type":"object", "description":"Attributes of the corresponding model. \nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n", "additionalProperties":{ "type":"object", "properties":{ } } }, "approvalRequests":{ "type":"array", "description":"List of approval requests created as part of the access request", "items":{ "$ref":"#/definitions/ApprovalRequest" } } }, "description":"Description of AccessRequest." }, "AccessRequestCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of accessRequests.", "items":{ "$ref":"#/definitions/AccessRequestSummary" } } }, "description":"Results of a accessRequest search." }, "AccessRequestSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation" }, "justification":{ "type":"string", "description":"Justification for creating or updating the access request" }, "requestStatus":{ "type":"string", "description":"Status of the access request" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the the AccessRequest was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The time the the AccessRequest was updated. An RFC3339 formatted datetime string" } }, "description":"Summary of the AccessRequest." }, "NestedQuestionAttributeSummary":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"Question attributes", "items":{ "$ref":"#/definitions/QuestionAttributeDataSummary" } } }, "description":"Nested set of question attributes" }, "QuestionAttributeDataSummary":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Attribute name - Unique identifier" }, "values":{ "type":"array", "description":"Attribute Values", "items":{ "type":"string" } }, "children":{ "type":"array", "description":"nested attributes", "items":{ "$ref":"#/definitions/NestedQuestionAttributeSummary" } }, "isQuestion":{ "type":"boolean", "description":"Boolean value for checking if this is attribute is a question for requester." } }, "description":"Question Attributes of account profile" }, "ApprovalRequest":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"process instance id." }, "requestor":{ "type":"string", "description":"Identifier of the requestor." }, "beneficiary":{ "type":"string", "description":"Identifier of the beneficiary." }, "beneficiaryEmail":{ "type":"string", "description":"email of the beneficiary." }, "status":{ "type":"string", "description":"The status of the approval process instance.", "enum":[ "PENDING_APPROVALS", "INFO_REQUESTED", "APPROVED", "REJECTED", "DELETED", "FAILED", "CANCELLED", "PENDING_SOD", "PROVISIONED", "PROVISIONING_IN_PROGRESS", "PROVISIONING_FAILED" ], "x-obmcs-top-level-enum":"#/definitions/RequestStatus" }, "assignmentName":{ "type":"string", "description":"Name of the assignment that is being requested." }, "assignmentType":{ "type":"string", "description":"Type of the assignment that is being requested.", "enum":[ "ACCESS_BUNDLE", "ROLE", "IDENTITY_GROUP", "ACTIVE_GROUP", "CONSUMER_GROUP", "AG_ORGANIZATION" ], "x-obmcs-top-level-enum":"#/definitions/AssignmentType" }, "assignmentDescription":{ "type":"string", "description":"Description of the assignment that is being requested." }, "requestType":{ "type":"string", "description":"Type the request - workflow or no workflow.", "enum":[ "WORKFLOW", "NO_WORKFLOW" ], "x-obmcs-top-level-enum":"#/definitions/RequestType" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The last update date of the request." }, "failedDueToAccessGuardrailViolations":{ "type":"boolean", "description":"Boolean flag set to true if request failed due to Access Guardrail violations." }, "accessStartTime":{ "type":"string", "format":"date-time", "description":"The temporal access start time" }, "separationOfDutiesAnalysisRequests":{ "$ref":"#/definitions/SeparationOfDutiesRequestCollection" } }, "description":"Details of an Approval Request." }, "CreateExtensionRequestDetails":{ "type":"object", "required":[ "extensionDateInEpoch", "justification", "processInstanceId" ], "properties":{ "processInstanceId":{ "type":"string", "description":"Process Instance id of the request being extended" }, "extensionDateInEpoch":{ "type":"integer", "format":"int64", "description":"Requested extension date represented as epoch timestamp" }, "justification":{ "type":"string", "description":"Justification for creating the extension request" } }, "description":"The information about new ExtensionRequest." }, "ExtensionRequest":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation of extension request." }, "processInstanceId":{ "type":"string", "description":"Process Instance id of the request being extended" }, "extensionDateInEpoch":{ "type":"integer", "format":"int64", "description":"Requested extension date represented as epoch timestamp" }, "justification":{ "type":"string", "description":"Justification for creating or updating the extension request" }, "requestStatus":{ "type":"string", "description":"Status of the extension request" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the the ExtensionRequest was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The time the the ExtensionRequest was last updated. An RFC3339 formatted datetime string" }, "createdBy":{ "type":"string", "description":"The user that created the request" } }, "description":"Description of ExtensionRequest." }, "TaskStatus":{ "type":"string", "description":"Possible task statuses.", "enum":[ "PENDING_APPROVAL", "APPROVED", "ASSIGNED", "MODIFIED", "REJECTED", "REMOVED", "DELETED", "INFO_REQUESTED", "ESCALATED", "ERROR", "CANCELLED" ] }, "TaskActionType":{ "type":"string", "description":"Possible task action values.", "enum":[ "REQUEST_INFO", "PROVIDE_INFO", "APPROVE", "MODIFY", "REASSIGN", "ASSIGN", "REMOVE", "REJECT", "CANCEL", "EXTENSION_REQUEST", "EXPIRE", "ACCESS_REQUEST" ] }, "InstanceTags":{ "type":"string", "description":"Possible approval process instance tags.", "enum":[ "SOD_VIOLATIONS", "EXPIRES_SOON", "EXTENSION_REQUEST", "ESCALATED" ] }, "TaskAssigneeScope":{ "type":"string", "description":"Task assignment scope to filter on.", "enum":[ "DIRECT", "INDIRECT" ] }, "ApprovalDecisionType":{ "type":"string", "description":"Whether to approve or reject an Approval task.", "enum":[ "APPROVE", "REJECT" ] }, "ApprovalTimeLimitType":{ "type":"string", "description":"Approval Time Limit Type.", "enum":[ "INDEFINITELY", "NUMBER_OF_HOURS", "NUMBER_OF_DAYS", "DATE_TIME_RANGE", "EXTENSION" ] }, "ApprovalType":{ "type":"string", "description":"Defines type of the approval.", "enum":[ "ACCESS_REQUEST", "REVISION_REQUEST", "DELETE_REQUEST", "ACCESS_REVIEW" ] }, "ApprovalTypeFilter":{ "type":"string", "description":"Defines type of approval type filters.", "enum":[ "ACCESS_REQUESTS_ONLY", "REQUESTS_FOR_ACCESS_ONLY", "REVISION_REQUESTS_ONLY", "ALL_EXCEPT_ACCESS_REVIEWS" ] }, "TaskCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of tasks.", "items":{ "$ref":"#/definitions/Task" } } }, "description":"Results of a task search." }, "Task":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier of the task provided by BPMN provider." }, "type":{ "type":"string", "description":"The type of approval.", "enum":[ "ACCESS_REQUEST", "REVISION_REQUEST", "DELETE_REQUEST", "ACCESS_REVIEW" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalType" }, "processId":{ "type":"string", "description":"Process definition ID." }, "instanceId":{ "type":"string", "description":"Process instance ID." }, "requestId":{ "type":"string", "description":"Request ID which is generated by the caller." }, "assignee":{ "type":"string", "description":"User who is assigned to the task." }, "status":{ "type":"string", "description":"The status of the task.", "enum":[ "PENDING_APPROVAL", "APPROVED", "ASSIGNED", "MODIFIED", "REJECTED", "REMOVED", "DELETED", "INFO_REQUESTED", "ESCALATED", "ERROR", "CANCELLED" ], "x-obmcs-top-level-enum":"#/definitions/TaskStatus" }, "lastAction":{ "$ref":"#/definitions/TaskAction" }, "context":{ "$ref":"#/definitions/InstanceContext" }, "timeDue":{ "type":"string", "format":"date-time", "description":"The due date of the task." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The creation date of the task." }, "timeCompleted":{ "type":"string", "format":"date-time", "description":"The completion date of the task." } }, "description":"The details of a process instance task." }, "TaskAction":{ "type":"object", "required":[ "action" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier of the task action." }, "parentId":{ "type":"string", "description":"Identifier of the parent action, if one exists." }, "action":{ "type":"string", "description":"The action type.", "enum":[ "REQUEST_INFO", "PROVIDE_INFO", "APPROVE", "MODIFY", "REASSIGN", "ASSIGN", "REMOVE", "REJECT", "CANCEL", "EXTENSION_REQUEST", "EXPIRE", "ACCESS_REQUEST" ], "x-obmcs-top-level-enum":"#/definitions/TaskActionType" }, "user":{ "type":"string", "description":"User who is performing the action." }, "comment":{ "type":"string", "description":"Reason for the action." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The creation date of the task." }, "approvalTimeLimitType":{ "type":"string", "description":"The approval time limit type.", "enum":[ "INDEFINITELY", "NUMBER_OF_HOURS", "NUMBER_OF_DAYS", "DATE_TIME_RANGE", "EXTENSION" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalTimeLimitType", "x-default-description":"INDEFINITELY" }, "approvalTimeLimit":{ "$ref":"#/definitions/ApprovalTimeLimit" }, "extensionTimeLimit":{ "$ref":"#/definitions/ExtensionTimeLimit" } }, "description":"An action which can be performed for a given task." }, "InstanceContext":{ "type":"object", "properties":{ "requestor":{ "type":"string", "description":"Display name of the process instance requestor." }, "beneficiary":{ "type":"string", "description":"Display name of the process instance beneficiary." }, "assignmentName":{ "type":"string", "description":"Name of the assignment that is being requested." }, "assignmentType":{ "type":"string", "description":"Type of the assignment that is being requested." }, "assignmentDescription":{ "type":"string", "description":"Description of the assignment that is being requested." }, "assignmentAttributes":{ "type":"object", "description":"Map for additional key, value string pairs.", "additionalProperties":{ "type":"object", "properties":{ } } }, "additionalAttributes":{ "type":"object", "description":"Map for additional key, value string pairs.", "additionalProperties":{ "type":"string" } }, "assignmentTags":{ "type":"array", "description":"Assignment tags.", "items":{ "type":"string", "enum":[ "SOD_VIOLATIONS", "EXPIRES_SOON", "EXTENSION_REQUEST", "ESCALATED" ], "x-obmcs-top-level-enum":"#/definitions/InstanceTags" } }, "justification":{ "type":"string", "description":"Reason for the request." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The creation date of the process instance." }, "instanceVariables":{ "type":"array", "description":"Client specific context.", "items":{ "$ref":"#/definitions/InstanceVariable" } }, "message":{ "type":"string", "description":"Correlation message name." }, "timers":{ "type":"array", "description":"Timers to update.", "items":{ "$ref":"#/definitions/InstanceTimer" } } }, "description":"Context data pertaining to the process instance." }, "InstanceVariable":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"variable name" }, "value":{ "type":"object", "description":"value assigned to the variable", "properties":{ } }, "valuetype":{ "type":"string", "description":"The value type of the variable. It can be string, boolean, integer, long , double" } }, "description":"Variable of process instance" }, "InstanceTimer":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Timer id" }, "value":{ "type":"string", "description":"Timer value" } }, "description":"Timers of process instance" }, "ApprovalDecisionDetails":{ "type":"object", "required":[ "decisions" ], "properties":{ "decisions":{ "type":"array", "description":"List of Approval Task decisions.", "items":{ "$ref":"#/definitions/ApprovalDecision" } } }, "description":"A list of Approval Task decisions." }, "ApprovalDecision":{ "type":"object", "required":[ "action", "comment", "taskId" ], "properties":{ "taskId":{ "type":"string", "description":"The Approval Task ID for the decision." }, "action":{ "type":"string", "description":"APPROVE or REJECT", "enum":[ "APPROVE", "REJECT" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalDecisionType" }, "comment":{ "type":"string", "description":"Justification for decision." }, "approvalTimeLimitType":{ "type":"string", "description":"Optional approval time limit type.\nWhen type is INDEFINITELY, approvalTimeLimit and extensionTimeLimit should be left undefined.\nWhen type is NUMBER_OF_HOURS, NUMBER_OF_DAYS, or DATE_TIME_RANGE, approvalTimeLimit should be provided.\nWhen type is EXTENSION, extensionTimeLimit should be provided.\n", "enum":[ "INDEFINITELY", "NUMBER_OF_HOURS", "NUMBER_OF_DAYS", "DATE_TIME_RANGE", "EXTENSION" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalTimeLimitType", "x-default-description":"INDEFINITELY" }, "approvalTimeLimit":{ "$ref":"#/definitions/ApprovalTimeLimit" }, "extensionTimeLimit":{ "$ref":"#/definitions/ExtensionTimeLimit" } }, "description":"An individual Approval Task decision." }, "ApprovalTimeLimit":{ "type":"object", "properties":{ "daysLimit":{ "type":"integer", "description":"Approval time limit definition in days.", "minimum":1, "maximum":365 }, "hoursLimit":{ "type":"integer", "description":"Approval time limit definition in hours.", "minimum":1, "maximum":24 }, "rangeLimit":{ "$ref":"#/definitions/ApprovalTimeLimitRange" } }, "description":"Details about the approval time limit, when applicable. \nOnly one of daysLimit, hoursLimit, or timeRangeLimit should be defined.\n" }, "ApprovalTimeLimitRange":{ "type":"object", "required":[ "timeExpires", "timeStarts" ], "properties":{ "timeStarts":{ "type":"string", "format":"date-time", "description":"The start time as an RFC3339 formatted datetime string." }, "timeExpires":{ "type":"string", "format":"date-time", "description":"The expiration time as an RFC3339 formatted datetime string." } }, "description":"Approval time limit definition as a time range." }, "ExtensionTimeLimit":{ "type":"object", "required":[ "timeExpires" ], "properties":{ "timeExpires":{ "type":"string", "format":"date-time", "description":"The extended expiration time as an RFC3339 formatted datetime string." } }, "description":"Approval extension time limit definition as an end time." }, "ApprovalDecisionResults":{ "type":"object", "required":[ "failures" ], "properties":{ "status":{ "type":"string", "description":"Overall status of request." }, "failures":{ "type":"array", "description":"List of failures generated while creating task actions.", "items":{ "$ref":"#/definitions/ApprovalDecisionFailure" } } }, "description":"Response details of a set of Approval Task decisions." }, "ApprovalDecisionFailure":{ "type":"object", "required":[ "taskId" ], "properties":{ "taskId":{ "type":"string", "description":"Unique identifier of the task which failed to update." }, "errorMessage":{ "type":"string", "description":"Cause of the error." } }, "description":"Failure details of an Approval Task decision." }, "ApprovalDecisionWorkRequestDetails":{ "type":"object", "required":[ "action", "comment", "taskIds" ], "properties":{ "taskIds":{ "type":"array", "description":"List of Approval Task ids.", "items":{ "type":"string" } }, "action":{ "type":"string", "description":"APPROVE or REJECT.", "enum":[ "APPROVE", "REJECT" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalDecisionType" }, "comment":{ "type":"string", "description":"Justification for decision." }, "approvalTimeLimitType":{ "type":"string", "description":"Optional approval time limit type.\nWhen type is INDEFINITELY, approvalTimeLimit and extensionTimeLimit should be left undefined.\nWhen type is NUMBER_OF_HOURS, NUMBER_OF_DAYS, or DATE_TIME_RANGE, approvalTimeLimit should be provided.\nWhen type is EXTENSION, extensionTimeLimit should be provided.\n", "enum":[ "INDEFINITELY", "NUMBER_OF_HOURS", "NUMBER_OF_DAYS", "DATE_TIME_RANGE", "EXTENSION" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalTimeLimitType", "x-default-description":"INDEFINITELY" }, "approvalTimeLimit":{ "$ref":"#/definitions/ApprovalTimeLimit" }, "extensionTimeLimit":{ "$ref":"#/definitions/ExtensionTimeLimit" } }, "description":"A bulk decision for a set of tasks to create a work request." }, "RuleOperator":{ "type":"string", "description":"Rule operator.", "enum":[ "AND", "OR" ] }, "ConditionOperator":{ "type":"string", "description":"Condition operator.", "enum":[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TILL", "FROM", "BETWEEN", "NOT_BETWEEN", "IN", "NOT_IN", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH", "NOT_BEGINS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "IS_NULL", "IS_NOT_NULL", "EQUAL_WITH_NULL" ] }, "DataType":{ "type":"string", "description":"Data type for the values.", "enum":[ "STRING", "NUMBER", "BOOLEAN", "DATE" ] }, "ActionType":{ "type":"string", "description":"Remediation actions.", "enum":[ "REVOKE_IMMEDIATELY", "REVOKE_LATER" ] }, "Risk":{ "type":"string", "description":"Remediation actions.", "enum":[ "HIGH", "LOW" ] }, "AccessGuardrailLifecycleState":{ "type":"string", "description":"Possible lifecycle states for Access Guardrails.", "enum":[ "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" ] }, "AccessGuardrailCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of access guardrail.", "items":{ "$ref":"#/definitions/AccessGuardrailSummary" } } }, "description":"Results of a AccessGuardrail search. Contains both AccessGuardrailSummary items and other data." }, "AccessGuardrailSummary":{ "type":"object", "required":[ "id", "lifecycleState" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation" }, "name":{ "type":"string", "description":"Access Guardrail Identifier, can be renamed" }, "lifecycleState":{ "type":"string", "description":"The current state of the AccessGuardrail.", "enum":[ "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" ], "x-obmcs-top-level-enum":"#/definitions/AccessGuardrailLifecycleState" }, "tags":{ "type":"array", "description":"Tags for the AccessGuardrail.", "items":{ "type":"string" } }, "primaryOwnerDisplayName":{ "type":"string", "description":"DisplayName of the primary owner." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the the AccessGuardrail was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The time the the AccessGuardrail was updated. An RFC3339 formatted datetime string" } }, "description":"Summary of the AccessGuardrail." }, "AccessGuardrail":{ "type":"object", "required":[ "id", "lifecycleState" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "name":{ "type":"string", "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information." }, "description":{ "type":"string", "description":"description of the AccessGuardrail." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"The time the the AccessGuardrail was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The time the the AccessGuardrail was updated. An RFC3339 formatted datetime string" }, "lifecycleState":{ "type":"string", "description":"The current state of the AccessGuardrail.", "enum":[ "CREATING", "UPDATING", "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED" ], "x-obmcs-top-level-enum":"#/definitions/AccessGuardrailLifecycleState" }, "isDetectiveViolationCheckEnabled":{ "type":"boolean", "description":"Set to true for enabling detective violation check" }, "tags":{ "type":"array", "description":"Tags for the AccessGuardrail.", "items":{ "type":"string" } }, "rules":{ "$ref":"#/definitions/RuleCollection" }, "actionOnFailure":{ "$ref":"#/definitions/ActionOnFailure" }, "ownershipCollectionId":{ "type":"string", "description":"Id of the ownership collection associated with the AccessGuardrail." }, "primaryOwnerDisplayName":{ "type":"string", "description":"DisplayName of the primary owner." }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "createdBy":{ "type":"string", "description":"User name of the use who created the AccessGuardrail." }, "updatedBy":{ "type":"string", "description":"User name of the use who updated the AccessGuardrail." } }, "description":"Description of AccessGuardrail." }, "RuleCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of rule.", "items":{ "$ref":"#/definitions/Rule" } } }, "description":"Collection of rule." }, "Rule":{ "type":"object", "required":[ "conditions", "operator", "type" ], "properties":{ "id":{ "type":"string", "description":"AGCS Rule ID. Required when updating guardrail." }, "type":{ "type":"string", "description":"Type of rule used for parsing the rule.", "enum":[ "DEFAULT" ] }, "operator":{ "type":"string", "description":"Rule operator for the rule.", "enum":[ "AND", "OR" ], "x-obmcs-top-level-enum":"#/definitions/RuleOperator" }, "conditions":{ "$ref":"#/definitions/ConditionCollection" } }, "description":"The information about Rule." }, "ConditionCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of condition.", "items":{ "$ref":"#/definitions/Condition" } } }, "description":"Collection of conditions." }, "Condition":{ "type":"object", "required":[ "basicCondition", "type" ], "properties":{ "type":{ "type":"string", "description":"The type for AG Resource.", "enum":[ "IDENTITY_ATTRIBUTE", "PERMISSION", "DOES_NOT_HAVE_PERMISSION" ] }, "basicCondition":{ "$ref":"#/definitions/BasicCondition" }, "childConditions":{ "$ref":"#/definitions/BasicConditionCollection" }, "additionalAttributes":{ "type":"object", "description":"Additional attributes for additional information related to the condition.", "additionalProperties":{ "type":"string" } } }, "description":"The information about Condition." }, "BasicCondition":{ "type":"object", "required":[ "displayName", "lhs", "operator", "rhs" ], "properties":{ "displayName":{ "type":"string", "description":"Access Guardrails Identifier", "minLength":1, "maxLength":255 }, "operator":{ "type":"string", "description":"The operator for a access guardrail.", "enum":[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TILL", "FROM", "BETWEEN", "NOT_BETWEEN", "IN", "NOT_IN", "CONTAINS", "NOT_CONTAINS", "BEGINS_WITH", "NOT_BEGINS_WITH", "ENDS_WITH", "NOT_ENDS_WITH", "IS_NULL", "IS_NOT_NULL", "EQUAL_WITH_NULL" ], "x-obmcs-top-level-enum":"#/definitions/ConditionOperator" }, "lhs":{ "type":"string", "description":"Left hand side of the condition.", "minLength":1, "maxLength":512 }, "rhs":{ "type":"array", "description":"Right hand side of the condition.", "items":{ "type":"string" } }, "dataType":{ "type":"string", "description":"Data type for the condition identifier (lhs)", "enum":[ "STRING", "NUMBER", "BOOLEAN", "DATE" ], "x-obmcs-top-level-enum":"#/definitions/DataType" } }, "description":"The information about condition." }, "UiDetail":{ "type":"object", "required":[ "name", "value" ], "properties":{ "name":{ "type":"string", "description":"Name of value" }, "value":{ "type":"string", "description":"Value" } }, "description":"Ui detail for rendering values on UI" }, "BasicConditionCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of condition.", "items":{ "$ref":"#/definitions/BasicCondition" } } }, "description":"Collection of conditions." }, "ActionOnFailure":{ "type":"object", "required":[ "actionType", "shouldUserManagerBeNotified" ], "properties":{ "actionType":{ "type":"string", "description":"Action to be taken in case of access guardrail evaluation results in failure.", "enum":[ "REVOKE_IMMEDIATELY", "REVOKE_LATER" ], "x-obmcs-top-level-enum":"#/definitions/ActionType" }, "risk":{ "type":"string", "description":"Risk associated with action on failure.", "enum":[ "HIGH", "LOW" ], "x-obmcs-top-level-enum":"#/definitions/Risk" }, "revokeLaterAfterNumberOfDays":{ "type":"integer", "description":"Revoke permission after number of days.", "minimum":0, "maximum":90 }, "shouldUserManagerBeNotified":{ "type":"boolean", "description":"Should the user manager be notified in case of access guardrail evaluation results in failure." } }, "description":"The information about remediation in case of condition failure." }, "AnalyzeAccessGuardrailsDetails":{ "type":"object", "required":[ "globalIdentityIds" ], "properties":{ "globalIdentityIds":{ "type":"array", "description":"Global Identity Ids.", "items":{ "type":"string" } }, "accessGuardrailIds":{ "type":"array", "description":"Access Guardrail Ids.", "items":{ "type":"string" } } }, "description":"Request Body for analyzing Access Guardrails against Identities." }, "AnalyzeAccessGuardrailsResult":{ "type":"object", "required":[ "items", "violationCount" ], "properties":{ "violationCount":{ "type":"integer", "description":"violationCount." }, "items":{ "type":"array", "description":"Violation details corresponding to each global identity id.", "items":{ "$ref":"#/definitions/AnalyzeAccessGuardrailsViolationDetails" } } }, "description":"Response body for analyzing Access Guardrails against Identities." }, "AnalyzeAccessGuardrailsViolationDetails":{ "type":"object", "required":[ "globalIdentityId", "hasViolation" ], "properties":{ "globalIdentityId":{ "type":"string", "description":"globalIdentityId" }, "hasViolation":{ "type":"boolean", "description":"hasViolation" }, "accessGuardrailId":{ "type":"string", "description":"accessGuardrailId" }, "violationDetails":{ "type":"object", "description":"A map where keys represent unique rule identifiers and values are lists of violations.", "additionalProperties":{ "type":"array", "items":{ "type":"string" } } } }, "description":"Analyze Access Guardrails Violation details" }, "CreateAccessGuardrailDetails":{ "type":"object", "required":[ "actionOnFailure", "isDetectiveViolationCheckEnabled", "name", "owners", "rules" ], "properties":{ "name":{ "type":"string", "description":"Access Guardrail Identifier.", "minLength":1, "maxLength":255 }, "description":{ "type":"string", "description":"Description of the Access Guardrail.", "minLength":0, "maxLength":4000 }, "isDetectiveViolationCheckEnabled":{ "type":"boolean", "description":"Set to true for enabling detective violation check." }, "tags":{ "type":"array", "description":"Tags for the Access Guardrail.", "items":{ "type":"string" } }, "rules":{ "$ref":"#/definitions/RuleCollection" }, "actionOnFailure":{ "$ref":"#/definitions/ActionOnFailure" }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } } }, "description":"Details about new Access Guardrail." }, "UpdateAccessGuardrailDetails":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"AccessGuardrail Identifier", "minLength":0, "maxLength":255 }, "description":{ "type":"string", "description":"Description of the AccessGuardrail.", "minLength":0, "maxLength":4000 }, "isDetectiveViolationCheckEnabled":{ "type":"boolean", "description":"Set to true for enabling detective violation check" }, "tags":{ "type":"array", "description":"Tags for the AccessGuardrail.", "items":{ "type":"string" } }, "rules":{ "$ref":"#/definitions/RuleCollection" }, "actionOnFailure":{ "$ref":"#/definitions/ActionOnFailure" }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } } }, "description":"The information to be updated." }, "RoleCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Roles summary.", "items":{ "$ref":"#/definitions/RoleSummary" } } }, "description":"Results of a Role search. Contains both Role items and other data." }, "Role":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation" }, "name":{ "type":"string", "description":"Name of the Role" }, "description":{ "type":"string", "description":"Description of the Role" }, "requestableBy":{ "$ref":"#/definitions/IdInfo" }, "status":{ "type":"string", "description":"Status of the Role", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "approvalWorkflowId":{ "$ref":"#/definitions/IdInfo" }, "tags":{ "type":"array", "description":"List of tags attached to the Role", "items":{ "type":"string" } }, "accessBundles":{ "type":"array", "description":"List of Access Bundles", "items":{ "$ref":"#/definitions/AccessBundle" } }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Role was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Role was last updated. An RFC3339 formatted datetime string" }, "ownershipCollectionId":{ "type":"string", "description":"Ownership collection associate with the Role" }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "updatedBy":{ "$ref":"#/definitions/IdInfo" }, "customAttributes":{ "type":"object", "description":"Metadata associated with the role", "properties":{ } }, "externalId":{ "type":"string", "description":"ExternalId of the Role" }, "displayName":{ "type":"string", "description":"Display Name of the Role" }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Role.", "items":{ "$ref":"#/definitions/IdInfo" } } }, "description":"Role object." }, "RoleSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation" }, "name":{ "type":"string", "description":"Role name" }, "description":{ "type":"string", "description":"Role description" }, "status":{ "type":"string", "description":"Status of the Role", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "approvalWorkflowId":{ "type":"string", "description":"ApprovalWorkflowId that is applicable to the Role" }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "requestableBy":{ "type":"string", "description":"The identity type that may request the Access Bundle.", "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Role was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Role was last updated. An RFC3339 formatted datetime string" }, "tags":{ "type":"array", "description":"List of tags attached to the Role", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the access bundle", "properties":{ } }, "primaryOwner":{ "$ref":"#/definitions/PrimaryOwner" }, "isOwner":{ "type":"boolean", "description":"Boolean value checking if logged-in user is owner of this resource or not." }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Role.", "items":{ "$ref":"#/definitions/IdInfo" } } }, "description":"Role object summary." }, "CreateRoleDetails":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Role Identifier", "minLength":1, "maxLength":255 }, "description":{ "type":"string", "description":"Role description" }, "requestableBy":{ "type":"string", "description":"Entities that can request the access bundle", "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy" }, "approvalWorkflowId":{ "type":"string", "description":"ApprovalWorkflowId that is applicable to the Role" }, "tags":{ "type":"array", "description":"List of tags attached to the Role", "items":{ "type":"string" } }, "accessBundles":{ "type":"array", "description":"List of Access Bundles", "items":{ "$ref":"#/definitions/Info" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the role", "properties":{ } }, "externalId":{ "type":"string", "description":"ExternalId of the Role" }, "displayName":{ "type":"string", "description":"Display Name of the Role" }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Role.", "items":{ "$ref":"#/definitions/Info" } } }, "description":"The information about new Role." }, "UpdateRoleDetails":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Role name", "minLength":1, "maxLength":255 }, "description":{ "type":"string", "description":"Role description" }, "requestableBy":{ "type":"string", "description":"Entities that can request the access bundle", "enum":[ "ANY", "NONE", "MEMBERS_OF_AN_ORG" ], "x-obmcs-top-level-enum":"#/definitions/RequestableBy" }, "approvalWorkflowId":{ "type":"string", "description":"ApprovalWorkflowId that is applicable to the Role" }, "tags":{ "type":"array", "description":"List of tags attached to the Role", "items":{ "type":"string" } }, "accessBundles":{ "type":"array", "description":"List of Access Bundles", "items":{ "$ref":"#/definitions/Info" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the role", "properties":{ } }, "externalId":{ "type":"string", "description":"ExternalId of the Role" }, "displayName":{ "type":"string", "description":"Display Name of the Role" }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "organizations":{ "type":"array", "description":"List containing organizations information attached to the Role.", "items":{ "$ref":"#/definitions/Info" } } }, "description":"The information to be updated." }, "RoleSortBy":{ "type":"string", "description":"Role sort by fields.", "enum":[ "name", "timeUpdated", "createdBy" ] }, "PolicyAssignmentType":{ "type":"string", "description":"Defines type of the assignment - access bundle or role", "enum":[ "ACCESS_BUNDLE", "ROLE" ] }, "PolicyCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List containing summarized information about Policies.", "items":{ "$ref":"#/definitions/PolicySummary" } } }, "description":"PolicyCollection contains summarized information about Policies." }, "PolicySummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "name":{ "type":"string", "description":"A user-friendly name. Have to be unique. Avoid entering confidential information." }, "description":{ "type":"string", "description":"Description of the Policy." }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Policy was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Policy was last updated. An RFC3339 formatted datetime string" }, "status":{ "type":"string", "description":"Status of the Policy", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "tags":{ "type":"array", "description":"List of tags attached to the Policy.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the access bundle", "properties":{ } }, "primaryOwner":{ "$ref":"#/definitions/PrimaryOwner" }, "isOwner":{ "type":"boolean", "description":"Boolean value checking if logged-in user is owner of this resource or not." } }, "description":"Policy Summary." }, "Policy":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "name":{ "type":"string", "description":"A user-friendly name. Have to be unique, and it's changeable. Avoid entering confidential information." }, "description":{ "type":"string", "description":"Description of the Permission Association." }, "status":{ "type":"string", "description":"Status of the Permission Association.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Permission Association Rule was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Permission Association Rule was last updated. An RFC3339 formatted datetime string" }, "ownershipCollectionId":{ "type":"string", "description":"Ownership collection associate with the Identity Group" }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "updatedBy":{ "$ref":"#/definitions/IdInfo" }, "tags":{ "type":"array", "description":"List of tags attached to the Permission Association.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the permission association", "properties":{ } }, "displayName":{ "type":"string", "description":"displayName of the Permission Association" }, "assignments":{ "type":"array", "description":"List of assignments associated with Permission Association.", "items":{ "$ref":"#/definitions/PolicyAssignment" } }, "riskLevel":{ "type":"integer", "description":"Risk Level of Policy. 0 stands for low and 1 for high risk." } }, "description":"Policy model." }, "PolicyAssignment":{ "type":"object", "properties":{ "assignmentId":{ "type":"string", "description":"Assignment Id used for permission Association.." }, "assignmentType":{ "type":"string", "description":"Type of the assignment that is being requested.", "enum":[ "ACCESS_BUNDLE", "ROLE" ], "x-obmcs-top-level-enum":"#/definitions/PolicyAssignmentType" }, "identityType":{ "type":"string", "description":"Type of the identity" }, "identityCollections":{ "type":"array", "description":"List of identity collections", "items":{ "$ref":"#/definitions/Info" } }, "accessBundles":{ "type":"array", "description":"List of access bundles", "items":{ "$ref":"#/definitions/Info" } }, "roles":{ "type":"array", "description":"List of roles", "items":{ "$ref":"#/definitions/Info" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the permission association", "properties":{ } } }, "description":"PolicyAssignment Model." }, "CreatePolicyDetails":{ "type":"object", "required":[ "submittedBy" ], "properties":{ "name":{ "type":"string", "description":"A user-friendly name. Have to be unique, and it's changeable. Avoid entering confidential information." }, "description":{ "type":"string", "description":"Description of the Policy." }, "submittedBy":{ "type":"string", "description":"User or entity who submitted or created the Policy." }, "tags":{ "type":"array", "description":"List of tags attached to the Policy.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the Policy", "properties":{ } }, "displayName":{ "type":"string", "description":"displayName of the Policy" }, "assignments":{ "type":"array", "description":"List of assignments associated with Policy.", "items":{ "$ref":"#/definitions/PolicyAssignment" } }, "insights":{ "type":"string", "description":"Insights information of the policy" }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } } }, "description":"Model required for creating a new Policy" }, "UpdatePolicyDetails":{ "type":"object", "required":[ "submittedBy" ], "properties":{ "name":{ "type":"string", "description":"A user-friendly name. Have to be unique, and it's changeable. Avoid entering confidential information." }, "description":{ "type":"string", "description":"Description of the Policy." }, "submittedBy":{ "type":"string", "description":"User or entity who submitted or created the Policy." }, "tags":{ "type":"array", "description":"List of tags attached to the Policy.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the Policy", "properties":{ } }, "displayName":{ "type":"string", "description":"displayName of the Policy" }, "assignments":{ "type":"array", "description":"List of assignments associated with Policy.", "items":{ "$ref":"#/definitions/PolicyAssignment" } }, "owners":{ "type":"array", "description":"List of owner entities", "items":{ "$ref":"#/definitions/OwnerSummary" } } }, "description":"The information to be updated" }, "IdentityCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List containing summarized information about Identity Collections.", "items":{ "$ref":"#/definitions/IdentityCollectionSummary" } } }, "description":"IdentityCollection contains summarized information about Identity Collections." }, "AttributeConditionResponse":{ "type":"object", "properties":{ "attrKey":{ "$ref":"#/definitions/IdInfo" }, "operator":{ "$ref":"#/definitions/IdInfo" }, "attrValue":{ "type":"string", "description":"Attribute Value" }, "attrType":{ "type":"string", "description":"Attribute Type" }, "parentType":{ "type":"string", "description":"Parent Type" }, "parentId":{ "type":"string", "description":"Parent Id" }, "values":{ "type":"array", "description":"Attribute Values for Multi Value operators", "items":{ "type":"string" } } }, "description":"Attribute condition." }, "IdentityCollectionSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "displayName":{ "type":"string", "description":"Display Name of the Identity Collection." }, "name":{ "type":"string", "description":"Name of the Identity Collection." }, "description":{ "type":"string", "description":"Description of the Identity Collection." }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Identity Collection was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Identity Collection was last updated. An RFC3339 formatted datetime string" }, "identityGroupType":{ "type":"string", "description":"Type of the Identity Collection." }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "membershipRule":{ "type":"string", "description":"Membership Rule for the Identity Collection, for ex. \"all { department EQ AG Department , addresses.country EQ India }\"." }, "status":{ "type":"string", "description":"Status of the Identity Collection.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "tags":{ "type":"array", "description":"List of tags attached to the Identity Collection.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the access bundle.", "properties":{ } }, "isManagedAtOrchestratedSystem":{ "type":"boolean", "description":"Boolean value checking if IC is shared with Orchestrated System." }, "orchestratedSystemMetadataAttributes":{ "type":"array", "description":"List of Orchestrated System configuration, required only when isManagedAtOrchestratedSystem is true.", "items":{ "$ref":"#/definitions/OrchestratedSystemMetadataAttributes" } }, "primaryOwner":{ "$ref":"#/definitions/PrimaryOwner" }, "isOwner":{ "type":"boolean", "description":"Boolean value checking if logged-in user is owner of this resource or not." } }, "description":"Summarized Identity Collection model." }, "CreateIdentityCollectionDetails":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Name of the Identity Collection.", "minLength":1, "maxLength":255 }, "description":{ "type":"string", "description":"Description of the Identity Collection.", "minLength":1, "maxLength":255 }, "includedIdentities":{ "type":"array", "description":"List of the included identities.", "items":{ "$ref":"#/definitions/IdInfo" } }, "excludedIdentities":{ "type":"array", "description":"List of excluded identities.", "items":{ "$ref":"#/definitions/IdInfo" } }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "membershipRule":{ "type":"string", "description":"Membership Rule for the Identity Collection, for ex. \"all { department EQ AG Department , addresses.country EQ India }\".", "minLength":1, "maxLength":255 }, "orchestratedSystemId":{ "type":"string", "description":"Orchestrated System Id of the Identity Collection." }, "tags":{ "type":"array", "description":"List of tags attached to the Identity Collection.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the identity collection.", "properties":{ } }, "externalId":{ "type":"string", "description":"externalId of the Identity Collection." }, "displayName":{ "type":"string", "description":"displayName of the Identity Collection." }, "isManagedAtOrchestratedSystem":{ "type":"boolean", "description":"Boolean value checking if IC is shared with Orchestrated System." }, "orchestratedSystemMetadataAttributes":{ "type":"array", "description":"List of Orchestrated System configuration.", "items":{ "$ref":"#/definitions/OrchestratedSystemMetadataAttributes" } }, "accessGuardrail":{ "type":"string", "description":"Id of the access guardrail attached to the Identity Collection" }, "revisionApprovalWorkflowId":{ "type":"string", "description":"Id of the approval workflow for processing revisions to the entity." } }, "description":"Model required for creating a new Identity Collection." }, "UpdateIdentityCollectionDetails":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"Name of the Identity Collection.", "minLength":1, "maxLength":255 }, "description":{ "type":"string", "description":"Description of the Identity Collection.", "minLength":1, "maxLength":255 }, "includedIdentities":{ "type":"array", "description":"List of included identities.", "items":{ "$ref":"#/definitions/IdInfo" } }, "excludedIdentities":{ "type":"array", "description":"List of excluded identities.", "items":{ "$ref":"#/definitions/IdInfo" } }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "membershipRule":{ "type":"string", "description":"Membership Rule for the Identity Collection, for ex. \"all { department EQ AG Department , addresses.country EQ India }\".", "minLength":1, "maxLength":255 }, "tags":{ "type":"array", "description":"List of tags attached to the Identity Collection.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the Identity Collection.", "properties":{ } }, "externalId":{ "type":"string", "description":"externalId of the Identity Group." }, "displayName":{ "type":"string", "description":"displayName of the Identity Collection." }, "isManagedAtOrchestratedSystem":{ "type":"boolean", "description":"Boolean value checking if IC is shared with Orchestrated System." }, "orchestratedSystemMetadataAttributes":{ "type":"array", "description":"List of Orchestrated System configuration.", "items":{ "$ref":"#/definitions/OrchestratedSystemMetadataAttributes" } }, "currentMembers":{ "type":"integer", "description":"Current members in IC." }, "expectedMembers":{ "type":"integer", "description":"Expected members in IC." }, "agRisk":{ "$ref":"#/definitions/AGRiskModel" }, "accessGuardrail":{ "type":"string", "description":"Id of the access guardrail attached to the Identity Collection" }, "revisionApprovalWorkflowId":{ "type":"string", "description":"Id of the approval workflow for processing revisions to the entity." }, "revisionStatus":{ "type":"string", "description":"Status of the revision.", "enum":[ "NONE", "DRAFT", "REVISION_REQUESTED", "DELETE_REQUESTED", "CANCELED", "APPROVED", "REJECTED", "DELETE_REJECTED", "FAILED", "INFO_REQUESTED" ], "x-obmcs-top-level-enum":"#/definitions/RevisionStatus", "x-default-description":"DRAFT" } }, "description":"The information to be updated." }, "ParsedIdentityRuleResponse":{ "type":"object", "properties":{ "bindingOperator":{ "type":"string", "description":"Binding operator" }, "parsedOn":{ "type":"string", "description":"Parsed On timestamp as string." }, "attributeConditions":{ "type":"array", "description":"Attribute condition", "items":{ "$ref":"#/definitions/AttributeConditionResponse" } } }, "description":"Parsed membership rule object." }, "IdentityCollectionDetails":{ "type":"object", "properties":{ "includedIdentities":{ "type":"array", "description":"List of included identities.", "items":{ "type":"string" } }, "excludedIdentities":{ "type":"array", "description":"List of excluded identities.", "items":{ "type":"string" } }, "membershipRule":{ "type":"string", "description":"Membership Rule for the Identity Collection, for ex. \"all { department EQ AG Department , addresses.country EQ India }\".", "minLength":1, "maxLength":255 } }, "description":"Final Identities search body." }, "IdentitySummaryListPreviewCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of identities", "items":{ "$ref":"#/definitions/IdentitySummary" } } }, "description":"List of Identities and tally counts." }, "TopGroupTally":{ "type":"object", "required":[ "name", "value" ], "properties":{ "name":{ "type":"string", "description":"The name of the top group value" }, "value":{ "type":"integer", "description":"The count or frequency of the group" } }, "description":"The tally counts of the top value in the group" }, "SummaryReport":{ "type":"object", "required":[ "matchedCount", "totalCount" ], "properties":{ "matchedCount":{ "type":"integer", "description":"The count of items that matched the rule and included identities and excluded identities." }, "totalCount":{ "type":"integer", "description":"The total number of items." } }, "description":"the tally of preview data." }, "GroupCountAggregationCollection":{ "type":"object", "required":[ "items" ], "properties":{ "totalEntityCount":{ "type":"integer", "description":"The count of entities that match rule and search keyword." }, "items":{ "type":"array", "description":"The list of group-by values in this group.", "items":{ "$ref":"#/definitions/TopGroupTally" } } }, "description":"The tally counts of the group." }, "CreateIdentityCollectionMembersQueryDetails":{ "type":"object", "properties":{ "userIds":{ "type":"array", "description":"List of user ids to include in the response list.", "items":{ "type":"string" } } }, "description":"Query details to retrieve members of Identity Group." }, "IdentityCollectionResponse":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "name":{ "type":"string", "description":"Name of the Identity Collection." }, "description":{ "type":"string", "description":"Description of the Identity Collection." }, "status":{ "type":"string", "description":"Status of the Identity Group.", "enum":[ "ACTIVE", "DRAFT", "INACTIVE", "PENDING", "FAILED", "IN_PROGRESS", "SAVED", "SUCCESS", "TIMEOUT" ], "x-obmcs-top-level-enum":"#/definitions/EntityStatus", "x-default-description":"ACTIVE" }, "orchestratedSystemId":{ "type":"string", "description":"Orchestrated System Id associated with the Identity Collection." }, "membershipRule":{ "type":"string", "description":"Membership Rule for the Identity Collection, for ex. \"all { department EQ AG Department , addresses.country EQ India }\"." }, "parsedMembers":{ "type":"array", "description":"List of the parsed Identities.", "items":{ "$ref":"#/definitions/IdentitySummary" } }, "parsedIdentityRule":{ "$ref":"#/definitions/ParsedIdentityRuleResponse" }, "includedIdentities":{ "type":"array", "description":"List of the included identities.", "items":{ "$ref":"#/definitions/IdentitySummary" } }, "excludedIdentities":{ "type":"array", "description":"List of the excluded identities.", "items":{ "$ref":"#/definitions/IdentitySummary" } }, "ownershipCollectionId":{ "type":"string", "description":"Ownership collection associate with the Identity Collection." }, "owners":{ "type":"array", "description":"List of owner entities.", "items":{ "$ref":"#/definitions/OwnerSummary" } }, "createdBy":{ "$ref":"#/definitions/IdInfo" }, "updatedBy":{ "$ref":"#/definitions/IdInfo" }, "timeCreated":{ "type":"string", "format":"date-time", "description":"Time when the Identity Collection was created. An RFC3339 formatted datetime string" }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"Time when the Identity Collection was last updated. An RFC3339 formatted datetime string" }, "identityGroupType":{ "type":"string", "description":"Type of the Identity Collection.", "minLength":1, "maxLength":255 }, "finalIdentities":{ "type":"array", "description":"List of the final Identities.", "items":{ "$ref":"#/definitions/IdentitySummary" } }, "tags":{ "type":"array", "description":"List of tags attached to the Identity Collection.", "items":{ "type":"string" } }, "customAttributes":{ "type":"object", "description":"Metadata associated with the policy rule.", "properties":{ } }, "externalId":{ "type":"string", "description":"externalId of the Identity Collection." }, "displayName":{ "type":"string", "description":"displayName of the Identity Collection." }, "isManagedAtOrchestratedSystem":{ "type":"boolean", "description":"Boolean value checking if IC is shared with Orchestrated Systems." }, "orchestratedSystemMetadataAttributes":{ "type":"array", "description":"List of Orchestrated System configuration.", "items":{ "$ref":"#/definitions/OrchestratedSystemMetadataAttributes" } }, "accessGuardrail":{ "$ref":"#/definitions/AccessGuardrailDetails" }, "revisionApprovalWorkflow":{ "$ref":"#/definitions/IdInfo" }, "revisionStatus":{ "type":"string", "description":"Status of the revision.", "enum":[ "NONE", "DRAFT", "REVISION_REQUESTED", "DELETE_REQUESTED", "CANCELED", "APPROVED", "REJECTED", "DELETE_REJECTED", "FAILED", "INFO_REQUESTED" ], "x-obmcs-top-level-enum":"#/definitions/RevisionStatus", "x-default-description":"NONE" }, "revisionVersion":{ "type":"string", "description":"Version of the revision" }, "revisionRequestId":{ "type":"string", "description":"request Id for the revision" }, "processInstanceId":{ "type":"string", "description":"process instance id of approval management" } }, "description":"Identity Collection model." }, "IdentitySummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "name":{ "type":"string", "description":"A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information." }, "userLogin":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "email":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "manager":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "organization":{ "type":"string", "description":"The Unique Oracle ID (OCID) that is immutable on creation." }, "isRuleBased":{ "type":"boolean", "description":"(optional parameter) Is this identity ruled based." }, "jobCode":{ "type":"string", "description":"The jobCode of the identity." }, "location":{ "type":"string", "description":"The location of the identitiy." }, "employeeType":{ "type":"string", "description":"The employeeType of the identitiy." }, "agOrganizations":{ "type":"array", "description":"The AGOrganizations of which the identity is part of.", "items":{ "type":"string" } } }, "description":"Identity Summary." }, "SeparationOfDutiesStatusResponse":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of request status.", "items":{ "$ref":"#/definitions/SeparationOfDutiesStatus" } } }, "description":"Current status of one or more separation of duties requests." }, "SeparationOfDutiesStatus":{ "type":"object", "required":[ "requestId", "requestStatus", "requestedBy", "sodEvents" ], "properties":{ "requestId":{ "type":"string", "description":"Unique identifier that is immutable on creation." }, "requestStatus":{ "type":"string", "description":"Request status.", "enum":[ "SUCCESS", "FAILED", "IN_PROGRESS" ], "x-obmcs-top-level-enum":"#/definitions/SeparationOfDutiesRequestStatus" }, "timeRequested":{ "type":"string", "format":"date-time", "description":"Request time." }, "timeRequestCompletion":{ "type":"string", "format":"date-time", "description":"Request completion time." }, "requestedBy":{ "type":"string", "description":"Requested by." }, "sodEvents":{ "type":"array", "description":"One or more separation of duties events.", "items":{ "$ref":"#/definitions/SeparationOfDutiesEvent" } } }, "description":"Separation of Duties status." }, "SeparationOfDutiesViolationDetail":{ "type":"object", "required":[ "accessPoint", "conflictingRole" ], "properties":{ "conflictingRole":{ "type":"string", "description":"The name of the conflicting role." }, "accessPoint":{ "type":"string", "description":"The name of the access point." } }, "description":"Detail of a single separation of duties violation." }, "BindingOperator":{ "type":"string", "description":"An expression binding operator.", "enum":[ "ALL", "ANY" ] }, "IdentityConsumerFilterTypes":{ "type":"string", "description":"A Identity consumer/workforce filter.", "enum":[ "CONSUMER", "WORKFORCE" ] }, "Operator":{ "type":"string", "description":"Expression operator.", "enum":[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TO", "FROM", "CONTAINS", "NOT_CONTAINS" ] }, "AttributeOptionalField":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"name of the field." }, "value":{ "type":"object", "description":"Value of the field.", "properties":{ } } }, "description":"An optional Attribute field." }, "AccountStatus":{ "type":"string", "description":"Account Status.", "enum":[ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DELETE_IN_PROGRESS", "ENABLE_FAILED", "DISABLE_FAILED", "DELETE_FAILED" ] }, "AccountSummary":{ "type":"object", "required":[ "id" ], "properties":{ "id":{ "type":"string", "description":"Global Identity id of the account owner." }, "name":{ "type":"string", "description":"Name of the account owner." }, "passwordChangeStatus":{ "type":"string", "description":"Password change status." }, "isPmProvisioned":{ "type":"boolean", "description":"Indicates if provisioned by PM." }, "timeUpdated":{ "type":"string", "format":"date-time", "description":"The time the Account was updated. An RFC3339 formatted datetime string." }, "resourceName":{ "type":"string", "description":"Name of the Resource." }, "orchestratedSystemIdentityId":{ "type":"string", "description":"Orchestrated system Identity Id of the account owner." }, "grantType":{ "type":"string", "description":"Grant Type of the Account." }, "orchestratedSystemType":{ "type":"string", "description":"Type of the Orchestrated System." }, "risk":{ "type":"string", "description":"Insights prediction value." }, "isPolicyGrant":{ "type":"boolean", "description":"Indicates if the account is associated with any Policy." }, "accountStatus":{ "type":"string", "description":"Status of the Account.", "enum":[ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DELETE_IN_PROGRESS", "ENABLE_FAILED", "DISABLE_FAILED", "DELETE_FAILED" ], "x-obmcs-top-level-enum":"#/definitions/AccountStatus", "x-default-description":"DISABLED" }, "canDisable":{ "type":"boolean", "description":"Flag to show the disabling capability of the account." }, "canDelete":{ "type":"boolean", "description":"Flag to show the deleting capability of the account." }, "state":{ "type":"string", "description":"State of the last processing event.", "enum":[ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DELETE_IN_PROGRESS", "ENABLE_FAILED", "DISABLE_FAILED", "DELETE_FAILED" ], "x-obmcs-top-level-enum":"#/definitions/AccountStatus", "x-default-description":"DISABLED" }, "orchestratedSystem":{ "$ref":"#/definitions/Info" } }, "description":"Summary of the Account." }, "AccountCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Accounts.", "items":{ "$ref":"#/definitions/AccountSummary" } } }, "description":"List of Accounts." }, "ActivatedIdentityResponse":{ "type":"object", "required":[ "activatedIdentity" ], "properties":{ "activatedIdentity":{ "type":"string", "description":"The successfully activated identity ID." } }, "description":"Response model containing the successfully activated identity ID." }, "TerminatedIdentityResponse":{ "type":"object", "required":[ "terminatedIdentity" ], "properties":{ "terminatedIdentity":{ "type":"string", "description":"The successfully terminated identity ID." } }, "description":"Response model containing the successfully terminated identity ID." }, "AttributesType":{ "type":"string", "description":"The Type for attributes in Access Governance Type", "enum":[ "FULL", "CUSTOM_ON_IDENTITY_PAGE", "CUSTOM_CAMPAIGN_SELECTION", "CUSTOM_CAMPAIGN_EVENT", "CUSTOM_IDENTITY_LIFE_CYCLE", "CUSTOM_ON_MATCHING_RULES", "CUSTOM_ON_MAPPING_RULES", "CUSTOM_ON_ENTITY_VIEW", "OWNERSHIP_CAMPAIGN_VIEW" ] }, "AttributesNamespace":{ "type":"string", "description":"The Namespace selection for attributes in Access Governance Type", "enum":[ "ALL", "DEFAULTS", "CUSTOM", "AFFILIATION", "ALL_NO_AFFILIATION" ] }, "IdentityAttributeSummary":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numeric Id." }, "name":{ "type":"string", "description":"Description of attribute." }, "operandType":{ "type":"string", "description":"Type of Operand." } }, "description":"Identity Attributes." }, "IdentityAttributeCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Identity Attributes.", "items":{ "$ref":"#/definitions/IdentityAttributeSummary" } } }, "description":"List of Identity Attributes." }, "IdentityOperatorSummary":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Numeric Id." }, "name":{ "type":"string", "description":"Description of operator." }, "operatorSyntax":{ "type":"string", "description":"Syntax of operator." } }, "description":"Identity Operators." }, "IdentityOperatorCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Identity Operators.", "items":{ "$ref":"#/definitions/IdentityOperatorSummary" } } }, "description":"List of Identity Operators." }, "IdentityAttributeValueSummaryCollection":{ "type":"object", "required":[ "items" ], "properties":{ "items":{ "type":"array", "description":"List of Identity Attribute values.", "items":{ "$ref":"#/definitions/IdentityAttributeValueSummary" } } }, "description":"List of Identity Attribute values." }, "IdentityAttributeValueSummary":{ "type":"object", "required":[ "name" ], "properties":{ "name":{ "type":"string", "description":"value of the Identity Attribute." } }, "description":"The summary of the Identity Attribute." }, "Type":{ "type":"string", "description":"The Type in Access Governance.", "enum":[ "IDENTITY", "ORCHESTRATED_SYSTEM_ACCOUNT" ] }, "TypeDetails":{ "type":"object", "required":[ "description", "name", "schema", "type", "typeId" ], "properties":{ "typeId":{ "type":"string", "description":"The id for the Type available in Access Governance." }, "type":{ "type":"string", "description":"The Type in Access Governance.", "enum":[ "IDENTITY", "ORCHESTRATED_SYSTEM_ACCOUNT" ], "x-obmcs-top-level-enum":"#/definitions/Type" }, "name":{ "type":"string", "description":"The name for Type." }, "description":{ "type":"string", "description":"The description for the Type available in Access Governance." }, "schema":{ "type":"string", "description":"The schema for Type available in Access Governance." } }, "description":"The Type available in Access Governance." }, "CampaignScope":{ "description":"scope of the campaign.", "type":"string", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ] }, "JustificationType":{ "type":"string", "description":"The type of justification rule to allow.", "enum":[ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ] }, "CampaignType":{ "type":"string", "description":"The type of campaign.", "enum":[ "ACCESS", "OWNERSHIP" ] }, "CriteriaType":{ "type":"string", "description":"The type of criteria.", "enum":[ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL", "GRANTED_PERMISSION_TYPE", "TEMPORAL_TYPE" ] }, "ReviewerType":{ "type":"string", "description":"The reviewer type.", "enum":[ "CUSTOM_OWNER", "OWNER", "USER", "USER_MANAGER", "CLOUD_REVIEWER", "APPROVAL_SYSTEM", "REQUESTOR", "BENEFICIARY", "BENEFICIARY_MANAGER", "CUSTOM_USER", "GROUP", "MANAGER_CHAIN", "SYSTEM", "NO_APPROVAL" ] }, "RecipientType":{ "type":"string", "description":"The recipient type.", "enum":[ "REVIEWER", "REVIEWER_AND_MANAGER" ] }, "CampaignCriteria":{ "type":"object", "description":"The criteria filter.", "required":[ "type" ], "properties":{ "type":{ "type":"string", "description":"The type of the criteria.", "x-obmcs-top-level-enum":"#/definitions/CriteriaType", "enum":[ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL", "GRANTED_PERMISSION_TYPE", "TEMPORAL_TYPE" ] }, "criteriaValue":{ "type":"array", "description":"The list of values of the criteria.", "items":{ "$ref":"#/definitions/CriteriaValue" }, "maxItems":500 }, "conditions":{ "description":"Filter condition (these conditions have an AND binding between them).", "type":"array", "items":{ "$ref":"#/definitions/Condition" }, "maxItems":100 }, "subCriteria":{ "type":"array", "description":"The list of values of the Campaign criteria", "items":{ "$ref":"#/definitions/CampaignCriteria" }, "maxItems":500 } } }, "CriteriaValue":{ "type":"object", "description":"The criteria value.", "required":[ "name" ], "properties":{ "id":{ "description":"The ID of the value.", "type":"string" }, "name":{ "description":"The name of the value.", "type":"string" }, "subCriteria":{ "type":"array", "description":"The list of values of the Campaign criteria.", "items":{ "$ref":"#/definitions/CampaignCriteria" }, "maxItems":500 } } }, "Frequency":{ "type":"string", "description":"The frequency of a campaign.", "enum":[ "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ] }, "CampaignState":{ "type":"string", "description":"Possible lifecycle states.", "enum":[ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ] }, "ApprovalProcessStageOperator":{ "type":"string", "description":"Approval ApprovalProcess ApprovalProcessStage Operator.", "enum":[ "ANY", "ALL" ] }, "InstanceWorkflowStatus":{ "type":"string", "description":"Possible task statuses.", "enum":[ "COMPLETED", "PENDING_APPROVAL" ] }, "CompletionType":{ "type":"string", "description":"The type of completion rule to perform.", "enum":[ "APPROVE_ALL", "REVOKE_ALL" ] }, "SubmissionType":{ "description":"Submission type of this action.", "type":"string", "enum":[ "SAVE", "SUBMIT", "SUBMIT_NOW", "EWB_IDENTITY", "EWB_AC" ] }, "GroupType":{ "type":"string", "description":"The type of the group.", "enum":[ "ORGANIZATION", "RESOURCE", "ROLE", "CLOUD_ACCOUNT", "POLICY_CREATED_SINCE", "IC_CREATED_SINCE", "UA_TARGET", "UA_INSIGHTS", "AG_ORGANIZATION" ] }, "ReviewerAttributeType":{ "type":"string", "description":"The type of reviewer attribute.", "enum":[ "APPLICATION_OWNER", "ROLE_OWNER", "ENTITLEMENT_OWNER", "CLOUD_RESOURCE_OWNER" ] }, "ReviewerIdType":{ "type":"string", "description":"The type of the ID.", "enum":[ "USER" ] }, "TerminateType":{ "type":"string", "description":"The termination type of a campaign.", "enum":[ "INSTANCE", "SERIES" ] }, "SystemCriteriaState":{ "type":"string", "description":"Possible criteria state.", "enum":[ "AVAILABLE", "NOT_AVAILABLE" ] }, "AgCriteriaType":{ "type":"string", "description":"Possible AG criteria type.", "enum":[ "AG_ENTITLEMENT", "AG_APPROVAL_WORKFLOW", "AG_IDENTITY_COLLECTION", "AG_SYSTEM", "AG_POLICY", "AG_ROLE", "AG_ACCESS_GUARDRAIL" ] }, "AgEntityType":{ "type":"string", "description":"Possible entity types.", "enum":[ "ACCESS_BUNDLES", "ACCESS_GUARDRAILS", "APPROVAL_WORKFLOWS", "IDENTITY_COLLECTIONS", "ORCHESTRATED_SYSTEMS", "POLICIES", "ROLES" ] }, "CloudProviderType":{ "type":"string", "description":"The type of cloud provider", "enum":[ "OCI" ] }, "ExcludedReviewType":{ "type":"string", "description":"The review type of a review task.", "enum":[ "ACCOUNT", "ROLE" ] }, "CampaignSummary":{ "description":"Summary of the AgcsCampaign.", "type":"object", "required":[ "id", "displayName", "status", "type" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation.", "type":"string" }, "displayName":{ "description":"The campaign display name.", "type":"string" }, "type":{ "description":"The type of the campaign (access or ownership).", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "ownerName":{ "description":"The owner name of the campaign.", "type":"string" }, "ownerId":{ "description":"The owner ID of the campaign.", "type":"string" }, "creatorId":{ "description":"The ID of the creator.", "type":"string" }, "status":{ "description":"The status of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignState", "enum":[ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ] }, "timeStarted":{ "description":"The time that the campaign will start.", "type":"string", "format":"date-time" }, "timeDue":{ "description":"The time that the campaign will end.", "type":"string", "format":"date-time" }, "reviewProgress":{ "description":"The progress of the review.", "type":"number", "format":"float" }, "frequency":{ "description":"The frequency of a recurring campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/Frequency", "enum":[ "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ] }, "isRecurring":{ "description":"Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.", "type":"boolean" }, "scope":{ "description":"The scope of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignScope", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ] }, "isApprovalWfCampaign":{ "description":"If the current campaign is having approval workflow.", "type":"boolean" } } }, "CampaignCollection":{ "type":"object", "description":"Results of a campaign search.", "required":[ "items" ], "properties":{ "items":{ "description":"List of campaign summaries.", "type":"array", "items":{ "$ref":"#/definitions/CampaignSummary" } } } }, "Campaign":{ "description":"Summary of the AgcsCampaign.", "type":"object", "required":[ "id", "displayName", "status", "timeCreated", "type" ], "properties":{ "id":{ "description":"The Unique Oracle ID (OCID) that is immutable on creation.", "type":"string" }, "displayName":{ "description":"The campaign display name.", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"The type of the campaign (access or ownership). It will help UI to identify what to read in CampaignCriteria (criteriaValue or conditions).", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "ownerId":{ "description":"The campaign owner ID.", "type":"string", "minLength":1, "maxLength":255 }, "customReviewerId":{ "description":"User ID of the custom reviewer in the custom user workflow.", "type":"string", "minLength":1, "maxLength":255 }, "customReviewerName":{ "description":"Display name of the custom reviewer in the custom user workflow.", "type":"string" }, "ownerName":{ "description":"The campaign owner name.", "type":"string" }, "ownerUsername":{ "description":"The username of campaign owner.", "type":"string" }, "ownerEmail":{ "description":"The campaign owner email.", "type":"string" }, "creatorId":{ "description":"The ID of the campaign creator.", "type":"string", "minLength":1, "maxLength":255 }, "reviewProgress":{ "description":"The progress of the review.", "type":"number", "format":"float" }, "scope":{ "description":"The scope of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignScope", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ] }, "status":{ "description":"The current state of the AgcsCampaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignState", "enum":[ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ] }, "timeStarted":{ "description":"The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeDue":{ "description":"The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeCreated":{ "description":"The time the the AgcsCampaign was created. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "criteria":{ "description":"The selection criteria for the campaign.", "type":"array", "items":{ "$ref":"#/definitions/CampaignCriteria" }, "maxItems":20 }, "reviewExclusions":{ "description":"List of the review types which are excluded from campaign.", "type":"array", "items":{ "$ref":"#/definitions/ExcludedReviewType" }, "maxItems":20 }, "reviewWorkflowId":{ "description":"The review workflow ID associated with the reviewLevels.", "type":"string" }, "reviewLevels":{ "description":"The list of review level details.", "type":"array", "items":{ "$ref":"#/definitions/ReviewLevelDetails" }, "maxItems":20 }, "approvalWorkflow":{ "$ref":"#/definitions/InstanceWorkflow" }, "selectionReview":{ "$ref":"#/definitions/SelectionReview" }, "completionRule":{ "description":"The completion rule to apply during review expiry.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CompletionType", "enum":[ "APPROVE_ALL", "REVOKE_ALL" ] }, "justificationRule":{ "description":"The justification rule for the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/JustificationType", "enum":[ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ] }, "description":{ "description":"The description of the campaign.", "type":"string" }, "isRecurring":{ "description":"Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.", "type":"boolean" }, "timeSeriesStarted":{ "description":"The series start date of a recurring campaign. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "frequency":{ "description":"The frequency of a recurring campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/Frequency", "enum":[ "ONE_TIME", "MONTHLY", "QUARTERLY", "HALF_YEARLY", "YEARLY" ] }, "seriesRecurrences":{ "description":"The recurrence rule which describes the schedule to run a recurring campaign. It is a RFC5545 formatted string.", "type":"string", "format":"x-obmcs-recurring-time", "maxLength":255 }, "messages":{ "description":"The list of messages.", "type":"array", "items":{ "$ref":"#/definitions/Message" }, "maxItems":50 }, "submissionType":{ "description":"Submission type of this action.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SubmissionType", "enum":[ "SAVE", "SUBMIT", "SUBMIT_NOW", "EWB_IDENTITY", "EWB_AC" ] }, "timeLastPendingGenerated":{ "description":"The latest time the pending review tasks view was generated. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" } } }, "CreateCampaignDetails":{ "description":"The information about new campaign.", "type":"object", "required":[ "submissionType" ], "properties":{ "displayName":{ "description":"The display name of the campaign.", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"The campaign description.", "type":"string", "minLength":0, "maxLength":255 }, "type":{ "description":"The type of the campaign (access or ownership). It will help UI to identify what to read in CampaignCriteria (criteriaValue or conditions).", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "criteria":{ "description":"The criteria for the campaign.", "type":"array", "items":{ "$ref":"#/definitions/Criteria" }, "maxItems":20 }, "ownerId":{ "description":"User ID of campaign owner.", "type":"string", "minLength":1, "maxLength":255 }, "customReviewerId":{ "description":"User ID of the custom reviewer in the custom user workflow.", "type":"string", "minLength":1, "maxLength":255 }, "ownerName":{ "description":"The name of the campaign owner.", "type":"string", "minLength":1, "maxLength":255 }, "ownerUsername":{ "description":"The username of the campaign owner.", "type":"string", "minLength":1, "maxLength":255 }, "ownerEmail":{ "description":"The email of the campaign owner.", "type":"string", "minLength":1, "maxLength":255 }, "timeStarted":{ "description":"The start date of the campaign.", "type":"string", "format":"date-time" }, "reviewWorkflowId":{ "description":"The review workflow ID associated with the reviewLevels.", "type":"string" }, "reviewExclusions":{ "description":"List of the review types which are excluded from campaign.", "type":"array", "items":{ "$ref":"#/definitions/ExcludedReviewType" }, "maxItems":20 }, "justificationRule":{ "description":"The justification rule for the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/JustificationType", "enum":[ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ] }, "scope":{ "description":"The scope of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignScope", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ] }, "submissionType":{ "description":"Submission type of this action.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SubmissionType", "enum":[ "SAVE", "SUBMIT", "SUBMIT_NOW", "EWB_IDENTITY", "EWB_AC" ] }, "timeSeriesStarted":{ "description":"The series start date of a recurring campaign. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "isRecurring":{ "description":"Whether or not the campaign is recurring - if recurring, then the frequency and seriesRecurrences will also be provided.", "type":"boolean" }, "seriesRecurrences":{ "description":"The recurrence rule which describes the schedule to run a recurring campaign. It is a RFC5545 formatted string.", "type":"string", "format":"x-obmcs-recurring-time", "maxLength":255 } } }, "ReviewLevelDetails":{ "type":"object", "description":"The details of a review level.", "required":[ "level" ], "properties":{ "level":{ "description":"The level for this review.", "type":"integer" }, "reviewerType":{ "type":"string", "description":"The reviewer type for the level.", "x-obmcs-top-level-enum":"#/definitions/ReviewerType", "enum":[ "CUSTOM_OWNER", "OWNER", "USER", "USER_MANAGER", "CLOUD_REVIEWER", "APPROVAL_SYSTEM", "REQUESTOR", "BENEFICIARY", "BENEFICIARY_MANAGER", "CUSTOM_USER", "GROUP", "MANAGER_CHAIN", "SYSTEM", "NO_APPROVAL" ] }, "reviewerAttributes":{ "description":"The list of reviewer attributes (only when reviewerType is CUSTOM_OWNER or CLOUD_REVIEWER).", "type":"array", "items":{ "$ref":"#/definitions/ReviewerAttribute" }, "maxItems":20 }, "durationDays":{ "description":"The duration days for the review level.", "type":"integer", "minimum":1, "maximum":30 }, "notificationRecipient":{ "description":"The first notification recipient.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/RecipientType", "enum":[ "REVIEWER", "REVIEWER_AND_MANAGER" ] }, "reminderRecipient":{ "description":"The reminder notification recipient.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/RecipientType", "enum":[ "REVIEWER", "REVIEWER_AND_MANAGER" ] }, "reminderFrequencyDays":{ "description":"the reminder frequency in days.", "type":"integer", "minimum":0, "maximum":29 } } }, "ReviewerAttribute":{ "type":"object", "description":"The attributes of the reviewer.", "required":[ "type" ], "properties":{ "type":{ "description":"The type of reviewer.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ReviewerAttributeType", "enum":[ "APPLICATION_OWNER", "ROLE_OWNER", "ENTITLEMENT_OWNER", "CLOUD_RESOURCE_OWNER" ] }, "reviewerId":{ "description":"The ID of the reviewer.", "type":"string" }, "reviewerIdType":{ "description":"The type of the ID.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ReviewerIdType", "enum":[ "USER" ] }, "reviewerName":{ "description":"The name of the reviewer.", "type":"string" }, "reviewerEmail":{ "description":"The email of the reviewer.", "type":"string" } } }, "InstanceWorkflow":{ "description":"The workflow of an approval process instance.", "type":"object", "required":[ "displayName", "stages" ], "properties":{ "displayName":{ "description":"The approval workflow name.", "type":"string", "minLength":1, "maxLength":100 }, "stages":{ "description":"The approval workflow stages.", "type":"array", "items":{ "$ref":"#/definitions/InstanceWorkflowStage" }, "minItems":1, "maxItems":20 } } }, "InstanceWorkflowStage":{ "description":"The approval process instance stage.", "type":"object", "required":[ "id", "operator", "approvers" ], "properties":{ "id":{ "description":"The stage id. Must be unique within the process.", "type":"string" }, "operator":{ "description":"The operator for the approval process stage.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessStageOperator", "enum":[ "ANY", "ALL" ], "default":"ALL" }, "approvers":{ "description":"The approvals required for the stage to complete.", "type":"array", "items":{ "$ref":"#/definitions/InstanceWorkflowApprover" }, "minItems":1, "maxItems":20 }, "state":{ "description":"The current state of the approval stage.\nOnly one stage will be in 'PENDING_APPROVAL' state.\n", "type":"string", "x-obmcs-top-level-enum":"#/definitions/InstanceWorkflowStatus", "enum":[ "COMPLETED", "PENDING_APPROVAL" ] }, "totalTasks":{ "description":"Total review tasks.", "type":"integer", "format":"int64" }, "completedTasks":{ "description":"Completed review tasks.", "type":"integer", "format":"int64" } } }, "InstanceWorkflowApprover":{ "type":"object", "description":"The approvals required within the stage.", "required":[ "id", "templateDetails", "description" ], "properties":{ "id":{ "description":"The approver id. Must be unique within the stage.", "type":"string" }, "templateDetails":{ "$ref":"#/definitions/TemplateInstance" }, "description":{ "description":"A description of the approval.", "type":"string", "minLength":1, "maxLength":100 }, "isTemplateCompleted":{ "description":"If the current template is completed.", "type":"boolean" }, "state":{ "description":"The current state of the approval request for the approval type within the stage.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/InstanceWorkflowStatus", "enum":[ "COMPLETED", "PENDING_APPROVAL" ] }, "pendingCount":{ "description":"Pending review tasks.", "type":"integer", "format":"int64" } } }, "TemplateInstance":{ "type":"object", "description":"Instance of an approval template.", "required":[ "id" ], "properties":{ "id":{ "description":"The approval template name, must be unique.", "type":"string", "minLength":1, "maxLength":255 }, "name":{ "description":"The approval template name.", "type":"string", "minLength":1, "maxLength":255 }, "parameterValues":{ "description":"List of approval template parameter values.", "type":"array", "items":{ "$ref":"#/definitions/TemplateParamTuple" } } } }, "TemplateParamTuple":{ "type":"object", "description":"Value(s) for the template parameter identified by id.", "required":[ "id" ], "properties":{ "id":{ "description":"The template parameter id. Unique within the template parameter list.", "type":"string", "minLength":1, "maxLength":255 }, "description":{ "description":"Description of the template parameter id.", "type":"string", "minLength":1, "maxLength":255 } } }, "SelectionReview":{ "type":"object", "description":"The selection count summary for the campaign.", "required":[ "identityTally", "entitlementTally", "resourceTally", "roleTally", "policyTally", "identityCollectionTally", "approvalWorkflowTally", "systemTally", "accessGuardrailTally" ], "properties":{ "identityTally":{ "$ref":"#/definitions/Tally" }, "entitlementTally":{ "$ref":"#/definitions/Tally" }, "resourceTally":{ "$ref":"#/definitions/Tally" }, "roleTally":{ "$ref":"#/definitions/Tally" }, "policyTally":{ "$ref":"#/definitions/Tally" }, "identityCollectionTally":{ "$ref":"#/definitions/Tally" }, "approvalWorkflowTally":{ "$ref":"#/definitions/Tally" }, "systemTally":{ "$ref":"#/definitions/Tally" }, "accessGuardrailTally":{ "$ref":"#/definitions/Tally" } } }, "Tally":{ "type":"object", "description":"the tally.", "required":[ "matchedCount", "totalCount" ], "properties":{ "matchedCount":{ "description":"The count of items that matched the criteria.", "type":"integer" }, "totalCount":{ "description":"The total number of items.", "type":"integer" } } }, "Message":{ "description":"Information about an event.", "type":"object", "properties":{ "dateCreated":{ "description":"The unix timestamp of when the message was created.", "type":"string" }, "code":{ "description":"The message code.", "type":"string" }, "message":{ "description":"The message.", "type":"string" } } }, "StageReviewerSummaryCollection":{ "type":"object", "description":"The list of StageReviewerSummary.", "required":[ "items" ], "properties":{ "items":{ "description":"the items.", "type":"array", "items":{ "$ref":"#/definitions/StageReviewerSummary" } } } }, "StageReviewerSummary":{ "type":"object", "description":"The pending stage reviewer details.", "required":[ "displayName", "pendingCount" ], "properties":{ "displayName":{ "description":"The display name of the reviewer.", "type":"string" }, "email":{ "description":"The email of the reviewer.", "type":"string" }, "pendingCount":{ "description":"The pending count of review tasks.", "type":"integer" } } }, "OverviewReport":{ "type":"object", "description":"The overview report of the review task status.", "required":[ "timeGenerated", "assignmentTypeTotals", "groupTotals" ], "properties":{ "timeGenerated":{ "description":"The date that the overview report was generated.", "type":"string", "format":"date-time" }, "assignmentTypeTotals":{ "description":"The totals related to each assignment type.", "type":"array", "items":{ "$ref":"#/definitions/AssignmentTypeTally" } }, "groupTotals":{ "description":"The totals related to each group criteria.", "type":"array", "items":{ "$ref":"#/definitions/GroupTally" } }, "autoActionedCount":{ "description":"The count of tasks that were auto actioned.", "type":"integer" }, "totalCount":{ "description":"The total count of all access review tasks.", "type":"integer" } } }, "AssignmentTypeTally":{ "type":"object", "description":"The tally counts of the assignment type.", "required":[ "type", "pendingCount", "approvedCount", "revokedCount" ], "properties":{ "type":{ "description":"The type of the assignment.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "enum":[ "ACCOUNT", "PERMISSION", "ROLE", "POLICY", "IC_STRUCTURAL", "UNMATCHED_ACCOUNT", "ORCH_SYSTEM", "AM_WORKFLOW", "ACCESS_GUARDRAIL" ] }, "pendingCount":{ "description":"The count of the pending reviews.", "type":"integer" }, "approvedCount":{ "description":"The count of the approved reviews.", "type":"integer" }, "revokedCount":{ "description":"The count of the revoked reviews.", "type":"integer" }, "modifiedCount":{ "description":"The count of the modified reviews.", "type":"integer" }, "assignedCount":{ "description":"The count of the assigned reviews.", "type":"integer" }, "removedCount":{ "description":"The count of the removed reviews.", "type":"integer" } } }, "GroupTally":{ "type":"object", "description":"The tally counts of the group.", "required":[ "type", "topGroups" ], "properties":{ "type":{ "description":"The type of the group.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/GroupType", "enum":[ "ORGANIZATION", "RESOURCE", "ROLE", "CLOUD_ACCOUNT", "POLICY_CREATED_SINCE", "IC_CREATED_SINCE", "UA_TARGET", "UA_INSIGHTS", "AG_ORGANIZATION" ] }, "topGroups":{ "description":"The list of the top 5 values in this group.", "type":"array", "items":{ "$ref":"#/definitions/TopGroupTally" } } } }, "ChangeOwnerDetails":{ "description":"User ID of the new campaign owner.", "type":"object", "required":[ "ownerId" ], "properties":{ "ownerId":{ "description":"User ID of campaign owner.", "type":"string", "minLength":1, "maxLength":255 } } }, "AgCriteriaSummaryCollection":{ "type":"object", "description":"The list of AgCriteriaSummary.", "required":[ "items" ], "properties":{ "items":{ "description":"The list of AgCriteriaSummary.", "type":"array", "items":{ "$ref":"#/definitions/AgCriteriaSummary" } } } }, "AgCriteriaSummary":{ "type":"object", "description":"It contains the info of AG criteria type and criteria state.", "required":[ "type", "state" ], "properties":{ "type":{ "type":"string", "description":"The type of the AG criteria.", "x-obmcs-top-level-enum":"#/definitions/AgCriteriaType", "enum":[ "AG_ENTITLEMENT", "AG_APPROVAL_WORKFLOW", "AG_IDENTITY_COLLECTION", "AG_SYSTEM", "AG_POLICY", "AG_ROLE", "AG_ACCESS_GUARDRAIL" ] }, "state":{ "type":"string", "description":"The state of the criteria.", "x-obmcs-top-level-enum":"#/definitions/SystemCriteriaState", "enum":[ "AVAILABLE", "NOT_AVAILABLE" ] } } }, "EntityAttributeSummary":{ "description":"Entity Attributes.", "type":"object", "properties":{ "id":{ "description":"Attribute Id.", "type":"string" }, "name":{ "description":"Description of attribute.", "type":"string" }, "type":{ "description":"Type of Attribute.", "type":"string" }, "format":{ "description":"Format of Attribute Type.", "type":"string" }, "defaultOrder":{ "description":"Default order of attribute for display.", "type":"integer" }, "isAdvancedFilter":{ "description":"Indicated if attribute can be used in advanced filter.", "type":"boolean" }, "isAffiliation":{ "description":"Indicated if attribute in affiliation namespace of identity.", "type":"boolean" }, "isCustom":{ "description":"Indicated if attribute in custom namespace of identity.", "type":"boolean" } } }, "EntityAttributeCollection":{ "description":"List of attributes.", "type":"object", "required":[ "items" ], "properties":{ "items":{ "description":"List of attributes.", "type":"array", "items":{ "$ref":"#/definitions/EntityAttributeSummary" } } } }, "OperatorSummary":{ "type":"object", "description":"Valid operator list by data type. Contains Operator items.", "required":[ "dataType", "validOperators" ], "properties":{ "dataType":{ "description":"Data Type.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/DataType", "enum":[ "DATE", "NUMBER", "STRING", "BOOLEAN" ] }, "validOperators":{ "description":"List of Valid Operators.", "type":"array", "items":{ "$ref":"#/definitions/Operator" } } } }, "OperatorSummaryCollection":{ "type":"object", "description":"Valid operator list by data type. Contains Operator items.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Valid Operators.", "type":"array", "items":{ "$ref":"#/definitions/OperatorSummary" } } } }, "EntityAttributeValue":{ "type":"object", "description":"The EntityAttributeValue.", "required":[ "name", "value" ], "properties":{ "name":{ "type":"string", "description":"The name for Access Governance Type." }, "value":{ "type":"string", "description":"The json schema for Access Governance Type." } } }, "EntityAttributeValueCollection":{ "type":"object", "description":"A list of Entity Attribute Value item.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Entity AttributeValue items.", "type":"array", "items":{ "$ref":"#/definitions/EntityAttributeValue" } } } }, "KeywordFilteredDetails":{ "type":"object", "description":"The filters to apply along with the keyword contains filters.", "required":[ "scope" ], "properties":{ "criteria":{ "type":"array", "description":"The list of criteria.", "items":{ "$ref":"#/definitions/Criteria" }, "maxItems":20 }, "scope":{ "description":"The scope of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignScope", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ] }, "campaignType":{ "description":"Campaign type (ACCESS or OWNERSHIP). The default is ACCESS on backend.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "keywordContains":{ "type":"string", "description":"The substring to match the name or description to.", "maxLength":100 } } }, "ResourceCollection":{ "type":"object", "description":"Results of a resource search.", "required":[ "items" ], "properties":{ "items":{ "description":"List of resource summaries.", "type":"array", "items":{ "$ref":"#/definitions/ResourceSummary" } } } }, "Criteria":{ "type":"object", "description":"The criteria to use as a filter.", "required":[ "type" ], "properties":{ "type":{ "type":"string", "description":"The type of the criteria.", "x-obmcs-top-level-enum":"#/definitions/CriteriaType", "enum":[ "ORGANIZATION", "JOB_CODE", "IDENTITY_LOCATION", "RESOURCE", "RESOURCE_LOCATION", "ENTITLEMENT", "ROLE", "DOMAIN", "COMPARTMENT", "CLOUD_PROVIDER", "POLICY", "POLICY_CREATED", "CUSTOM_ATTRIBUTE", "CUSTOM_ATTRIBUTE_VALUE", "IDENTITY_COLLECTION", "IC_CREATED", "TARGET_IDENTITY", "TARGET", "GLOBAL_IDENTITY", "AM_WORKFLOW", "NOT_REVIEWED_SINCE", "ACCESS_GUARDRAIL", "GRANTED_PERMISSION_TYPE", "TEMPORAL_TYPE" ] }, "value":{ "type":"array", "description":"The list of values of the criteria (these values have an OR binding between them).", "items":{ "type":"string" }, "maxItems":500 }, "conditions":{ "description":"Filter condition (these conditions have an AND binding between them).", "type":"array", "items":{ "$ref":"#/definitions/Condition" }, "maxItems":100 }, "subCriteria":{ "type":"array", "description":"The list of values of the criteria.", "items":{ "$ref":"#/definitions/Criteria" } } } }, "EntitlementSummaryCollection":{ "type":"object", "description":"Results of a permission search.", "required":[ "items" ], "properties":{ "items":{ "description":"List of permission summaries.", "type":"array", "items":{ "$ref":"#/definitions/EntitlementSummary" } } } }, "EntitlementSummary":{ "type":"object", "description":"The summary of a permission.", "required":[ "id", "name" ], "properties":{ "id":{ "description":"The ID of the permission.", "type":"string" }, "name":{ "description":"The name of the permission.", "type":"string" }, "displayName":{ "description":"The display name of the permission.", "type":"string" }, "resourceDisplayName":{ "description":"The display name of the associated resource.", "type":"string" }, "permissionType":{ "description":"The type of the permission.", "type":"string" }, "ownerUsername":{ "description":"The permission owner/certifier of the entitlement.", "type":"string" }, "cloudAccount":{ "description":"The cloud account of the permission.", "type":"string" }, "domainName":{ "description":"The domain name of the permission.", "type":"string" }, "isBundle":{ "description":"If the entity is an bundle.", "type":"boolean" }, "expirationTime":{ "description":"The number of days or hours access bundle is time limited to.", "type":"integer" }, "accessLimitType":{ "description":"The type of access limit for entity - NUMBER_OF_DAYS or NUMBER_OF_HOURS.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AccessLimitType", "enum":[ "INDEFINITELY", "NUMBER_OF_DAYS", "NUMBER_OF_HOURS", "DATE_TIME_RANGE" ] } } }, "FilteredDetails":{ "type":"object", "description":"The filters to apply", "required":[ "scope" ], "properties":{ "criteria":{ "type":"array", "description":"The list of criteria", "items":{ "$ref":"#/definitions/Criteria" }, "maxItems":20 }, "scope":{ "description":"The scope of the campaign", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignScope", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ] }, "campaignType":{ "description":"Campaign type (ACCESS or OWNERSHIP). The default is ACCESS on backend.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "nameContains":{ "type":"string", "description":"The substring to match the name to", "maxLength":100 } } }, "RoleSummaryCollection":{ "type":"object", "description":"Results of a role summary search.", "required":[ "items" ], "properties":{ "items":{ "description":"List of role summaries.", "type":"array", "items":{ "$ref":"#/definitions/RoleSummary" } } } }, "IcCollection":{ "type":"object", "description":"List of identity collections.", "required":[ "items" ], "properties":{ "items":{ "description":"List of identity collection summaries.", "type":"array", "items":{ "$ref":"#/definitions/IcCollectionSummary" } } } }, "IcCollectionSummary":{ "type":"object", "description":"The summary of identity collection.", "required":[ "id", "name" ], "properties":{ "id":{ "description":"The ID of the identity collection.", "type":"string" }, "name":{ "description":"The name of the identity collection.", "type":"string" }, "displayName":{ "description":"The displayName of the identity collection.", "type":"string" }, "domainName":{ "description":"The domain that the identity collection belongs to.", "type":"string" }, "compartmentName":{ "description":"The compartment name in which the identity collection belongs to.", "type":"string" }, "compartmentFullName":{ "description":"The full path of the compartment in which the identity collection belongs to.", "type":"string" } } }, "CloudProviderCollection":{ "type":"object", "description":"List of cloud providers.", "required":[ "items" ], "properties":{ "items":{ "description":"List of cloud providers summaries.", "type":"array", "items":{ "$ref":"#/definitions/CloudProviderSummary" } } } }, "CloudProviderSummary":{ "type":"object", "description":"The summary of cloud provider.", "required":[ "id", "name" ], "properties":{ "id":{ "description":"The ID of the cloud provider.", "type":"string" }, "name":{ "description":"The name of the cloud provider.", "type":"string" }, "description":{ "description":"The description of the cloud provider.", "type":"string" }, "type":{ "description":"The type of the cloud provider.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CloudProviderType", "enum":[ "OCI" ] } } }, "DomainSummary":{ "type":"object", "description":"The summary of domain.", "required":[ "id", "name" ], "properties":{ "id":{ "description":"The ID of the domain.", "type":"string" }, "name":{ "description":"The name of the domain.", "type":"string" } } }, "CustomAttributeSummaryCollection":{ "type":"object", "description":"List of custom attribute value.", "required":[ "items" ], "properties":{ "items":{ "description":"List of custom attribute values.", "type":"array", "items":{ "$ref":"#/definitions/CustomAttributeSummary" } } } }, "CustomAttributeSummary":{ "type":"object", "description":"The summary of custom attribute.", "required":[ "name" ], "properties":{ "name":{ "description":"value of the custom attribute.", "type":"string" } } }, "CriteriaDetails":{ "type":"object", "description":"The filters to apply using the criteria details object.", "required":[ "scope" ], "properties":{ "criteria":{ "type":"array", "description":"The list of criteria.", "items":{ "$ref":"#/definitions/Criteria" }, "maxItems":20 }, "scope":{ "description":"The scope of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignScope", "enum":[ "GOVERNANCE_SYSTEM", "CLOUD_PROVIDER", "AG" ] }, "campaignType":{ "description":"Campaign type (ACCESS or OWNERSHIP). The default is ACCESS on backend.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] } } }, "Recommendation":{ "type":"string", "description":"The recommendation for the access review task.", "enum":[ "ACCEPT", "REVIEW" ] }, "IdentityReviewSortBy":{ "type":"string", "description":"Identity review tasks sort by fields.", "enum":[ "entityName", "assignmentName", "managerName", "recommendation", "daysRemaining", "campaignName", "appNames", "identityAttributes" ] }, "AccessControlReviewSortBy":{ "type":"string", "description":"Identity review tasks sort by fields.", "enum":[ "owner", "assignmentName", "recommendation", "daysRemaining", "campaignName" ] }, "OwnershipReviewSortBy":{ "type":"string", "description":"Identity review tasks sort by fields.", "enum":[ "owner", "assignmentName", "daysRemaining", "campaignName" ] }, "TemplateType":{ "type":"string", "description":"The template type of a campaign.", "enum":[ "IDENTITY", "AG_IDENTITY", "EVENT", "AG_EVENT", "CLOUD_PROVIDER", "POLICY", "IC_STRUCTURAL", "AG_POLICY", "GOVERNANCE_SYSTEM", "AG", "GOVERNANCE_SYSTEM_EVENT", "CLOUD_PROVIDER_EVENT" ] }, "AccountType":{ "type":"string", "description":"The type of an account.", "enum":[ "PRIMARY", "SERVICE" ] }, "EscalationDetails":{ "type":"object", "description":"escalation details object.", "properties":{ "name":{ "description":"name of user or group.", "type":"string" }, "level":{ "description":"escalation level.", "type":"integer" } } }, "AdditionalAttributes":{ "type":"object", "description":"Additional attributes.", "properties":{ "ownerName":{ "description":"name of the Owner.", "type":"string" }, "timeCreated":{ "description":"creation time.", "type":"string", "format":"date-time" }, "description":{ "description":"description.", "type":"string" } } }, "AssignmentAttributeType":{ "type":"string", "description":"The type of the assignment attribute.", "enum":[ "PERMISSIONS", "ROLES", "RESOURCES", "POLICY_COUNT", "ROLE_COUNT", "PERMISSION_TYPE", "GRANTED_PERMISSION_TYPE", "OWNERSHIP_COLLECTION_ID" ] }, "ValueDetail":{ "type":"object", "description":"The assignment attribute.", "required":[ "name" ], "properties":{ "id":{ "description":"The Id of the assignment attribute.", "type":"string" }, "name":{ "description":"The name of the assignment attribute.", "type":"string" } } }, "AssignmentAttribute":{ "type":"object", "description":"The assignment attribute.", "required":[ "type", "values" ], "properties":{ "type":{ "description":"The type of the assignment attribute.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AssignmentAttributeType", "enum":[ "PERMISSIONS", "ROLES", "RESOURCES", "POLICY_COUNT", "ROLE_COUNT", "PERMISSION_TYPE", "GRANTED_PERMISSION_TYPE", "OWNERSHIP_COLLECTION_ID" ] }, "values":{ "description":"The value of the assignment attribute.", "type":"array", "items":{ "$ref":"#/definitions/ValueDetail" } } } }, "EntityAttributeType":{ "type":"string", "description":"The type of the entity attribute.", "enum":[ "TENANCY_NAME", "COMPARTMENT_NAME", "COMPARTMENT_FULL_NAME", "CREATED_BY", "PRIMARY_OWNER", "CREATED_ON", "DOMAIN_NAME", "SHARED_WITH_ORCHESTRATED_SYSTEM", "FIRST_NAME", "LAST_NAME", "ORCHESTRATED_SYSTEM_ID", "ORCHESTRATED_SYSTEM_NAME", "ORPHAN_INSIGHT", "IDENTITY_ATTRIBUTE", "ORCHESTRATED_SYSTEM_TYPE", "ORCHESTRATED_SYSTEM_MODE" ] }, "EntityAttribute":{ "type":"object", "description":"The entity attribute.", "required":[ "type", "values", "isCustom" ], "properties":{ "type":{ "description":"The type of the entity attribute.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/EntityAttributeType", "enum":[ "TENANCY_NAME", "COMPARTMENT_NAME", "COMPARTMENT_FULL_NAME", "CREATED_BY", "PRIMARY_OWNER", "CREATED_ON", "DOMAIN_NAME", "SHARED_WITH_ORCHESTRATED_SYSTEM", "FIRST_NAME", "LAST_NAME", "ORCHESTRATED_SYSTEM_ID", "ORCHESTRATED_SYSTEM_NAME", "ORPHAN_INSIGHT", "IDENTITY_ATTRIBUTE", "ORCHESTRATED_SYSTEM_TYPE", "ORCHESTRATED_SYSTEM_MODE" ] }, "values":{ "type":"array", "description":"The list of entity attribute values.", "items":{ "type":"string" } }, "name":{ "description":"The name of the entity attribute.", "type":"string" }, "displayName":{ "description":"The display name of the entity attribute.", "type":"string" }, "format":{ "description":"The format for date custom attribute, null for others.", "type":"string" }, "isCustom":{ "description":"Is the attribute custom attribute or not.", "type":"boolean" } } }, "IdentityAccessReviewSummaryCollection":{ "type":"object", "description":"Results of an identity access reviews search.", "required":[ "items" ], "properties":{ "items":{ "description":"List of identity access review summaries.", "type":"array", "items":{ "$ref":"#/definitions/IdentityAccessReviewSummary" } } } }, "IdentityAccessReviewSummary":{ "type":"object", "description":"The summary of an access review task.", "required":[ "id", "entityName", "entityType", "assignmentName", "assignmentType", "campaignName", "campaignType", "daysRemaining", "justificationRule" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation.", "type":"string" }, "campaignId":{ "description":"Campaign Id for the review task.", "type":"string" }, "appNames":{ "description":"Application names associated with the identity review task.", "type":"array", "items":{ "type":"string" } }, "entityName":{ "description":"The entity name.", "type":"string" }, "entityType":{ "description":"The type of the entity.", "type":"string" }, "assignmentName":{ "description":"The name of the assignment to be reviewed.", "type":"string" }, "assignmentDescription":{ "description":"The description of the assignment to be reviewed.", "type":"string" }, "assignmentType":{ "description":"The type of the assignment to be reviewed.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "enum":[ "ACCOUNT", "PERMISSION", "ROLE", "POLICY", "IC_STRUCTURAL", "UNMATCHED_ACCOUNT", "ORCH_SYSTEM", "AM_WORKFLOW", "ACCESS_GUARDRAIL" ] }, "managerName":{ "description":"The name of the manager of the entity.", "type":"string" }, "recommendation":{ "description":"The recommendation for the access review task.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/Recommendation", "enum":[ "ACCEPT", "REVIEW" ] }, "campaignType":{ "description":"review task belongs to which campaign type (access or ownership).", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "campaignName":{ "description":"The campaign display name.", "type":"string" }, "daysRemaining":{ "description":"The number of days remaining.", "type":"integer" }, "justificationRule":{ "description":"The justification rule for the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/JustificationType", "enum":[ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ] }, "templateType":{ "description":"The template type of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TemplateType", "enum":[ "IDENTITY", "AG_IDENTITY", "EVENT", "AG_EVENT", "CLOUD_PROVIDER", "POLICY", "IC_STRUCTURAL", "AG_POLICY", "GOVERNANCE_SYSTEM", "AG", "GOVERNANCE_SYSTEM_EVENT", "CLOUD_PROVIDER_EVENT" ] }, "isReassignable":{ "description":"Flag indicating whether the review task can be reassigned or not.", "type":"boolean" }, "timeExpiresPriorStage":{ "description":"The minimum date decided by reviewers from previous stages when access expires for the temporal access. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeMaxExpires":{ "description":"The current max expiration time that the temporal access is allowed to have. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeExpires":{ "description":"The current end date that the temporal access is set to expire. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "isPriorStageAccessIndefinite":{ "description":"Whether the prior stage reviewer has chosen indefinite access.", "type":"boolean" }, "identityAttributes":{ "description":"Map of identity attributes key, value Object pairs.", "type":"object", "additionalProperties":{ "type":"object" } }, "hasError":{ "description":"The hasError set to true if there is any error while processing the request.", "type":"boolean" } } }, "AccessControlAccessReviewSummaryCollection":{ "type":"object", "description":"Results of an access control access reviews search.", "required":[ "items" ], "properties":{ "items":{ "description":"List of access control access review summaries.", "type":"array", "items":{ "$ref":"#/definitions/AccessControlAccessReviewSummary" } } } }, "AccessControlAccessReviewSummary":{ "type":"object", "description":"The summary of access control review task.", "required":[ "id", "assignmentName", "assignmentType", "recommendation", "campaignName", "campaignType", "daysRemaining" ], "properties":{ "id":{ "description":"The ID of the access control review task.", "type":"string" }, "campaignId":{ "description":"Campaign Id for the review task.", "type":"string" }, "assignmentName":{ "description":"The name of the assignment for access control review task.", "type":"string" }, "assignmentDescription":{ "description":"The description of the assignment to be reviewed.", "type":"string" }, "assignmentType":{ "description":"The type of the assignment to be reviewed.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "enum":[ "ACCOUNT", "PERMISSION", "ROLE", "POLICY", "IC_STRUCTURAL", "UNMATCHED_ACCOUNT", "ORCH_SYSTEM", "AM_WORKFLOW", "ACCESS_GUARDRAIL" ] }, "owner":{ "description":"The owner name of the access control review task.", "type":"string" }, "recommendation":{ "description":"The recommendation of the access control review task.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/Recommendation", "enum":[ "ACCEPT", "REVIEW" ] }, "campaignName":{ "description":"The campaign name of the access control review task.", "type":"string" }, "daysRemaining":{ "description":"The days remaining of the access control review task.", "type":"integer" }, "templateType":{ "description":"The template type of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TemplateType", "enum":[ "IDENTITY", "AG_IDENTITY", "EVENT", "AG_EVENT", "CLOUD_PROVIDER", "POLICY", "IC_STRUCTURAL", "AG_POLICY", "GOVERNANCE_SYSTEM", "AG", "GOVERNANCE_SYSTEM_EVENT", "CLOUD_PROVIDER_EVENT" ] }, "campaignType":{ "description":"review task belongs to which campaign type (access or ownership).", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "isReassignable":{ "description":"Flag indicating whether the review task can be reassigned or not.", "type":"boolean" } } }, "OwnershipAccessReviewSummaryCollection":{ "type":"object", "description":"Results of an ownership access reviews search.", "required":[ "items" ], "properties":{ "items":{ "description":"List of ownership access review summaries.", "type":"array", "items":{ "$ref":"#/definitions/OwnershipAccessReviewSummary" } } } }, "OwnershipAccessReviewSummary":{ "type":"object", "description":"The summary of ownership review task.", "required":[ "id", "assignmentName", "assignmentType", "recommendation", "campaignName", "campaignType", "daysRemaining" ], "properties":{ "id":{ "description":"The ID of the ownership review task.", "type":"string" }, "campaignId":{ "description":"Campaign Id for the review task.", "type":"string" }, "assignmentName":{ "description":"The name of the assignment for ownership review task.", "type":"string" }, "assignmentDescription":{ "description":"The description of the assignment to be reviewed.", "type":"string" }, "assignmentType":{ "description":"The type of the assignment to be reviewed.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "enum":[ "ACCOUNT", "PERMISSION", "ROLE", "POLICY", "IC_STRUCTURAL", "UNMATCHED_ACCOUNT", "ORCH_SYSTEM", "AM_WORKFLOW", "ACCESS_GUARDRAIL" ] }, "owner":{ "description":"The owner name of the ownership review task.", "type":"string" }, "recommendation":{ "description":"The recommendation of the ownership review task.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/Recommendation", "enum":[ "ACCEPT", "REVIEW" ] }, "campaignName":{ "description":"The campaign name of the ownership review task.", "type":"string" }, "daysRemaining":{ "description":"The days remaining of the ownership review task.", "type":"integer" }, "templateType":{ "description":"The template type of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TemplateType", "enum":[ "IDENTITY", "AG_IDENTITY", "EVENT", "AG_EVENT", "CLOUD_PROVIDER", "POLICY", "IC_STRUCTURAL", "AG_POLICY", "GOVERNANCE_SYSTEM", "AG", "GOVERNANCE_SYSTEM_EVENT", "CLOUD_PROVIDER_EVENT" ] }, "campaignType":{ "description":"review task belongs to which campaign type (access or ownership).", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] } } }, "AccessReview":{ "type":"object", "description":"The access review task.", "required":[ "id", "entityName", "entityType", "assignmentName", "assignmentType", "campaignName", "campaignType", "daysRemaining", "justificationRule" ], "properties":{ "id":{ "description":"Unique identifier that is immutable on creation.", "type":"string" }, "entityName":{ "description":"The entity name.", "type":"string" }, "entityType":{ "description":"The entity type.", "type":"string" }, "entityAttributes":{ "description":"The attributes of the entity.", "type":"array", "items":{ "$ref":"#/definitions/EntityAttribute" } }, "assignmentId":{ "description":"The id of the assignment to be reviewed.", "type":"string" }, "assignmentName":{ "description":"The name of the assignment to be reviewed.", "type":"string" }, "assignmentType":{ "description":"The type of the assignment to be reviewed.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "enum":[ "ACCOUNT", "PERMISSION", "ROLE", "POLICY", "IC_STRUCTURAL", "UNMATCHED_ACCOUNT", "ORCH_SYSTEM", "AM_WORKFLOW", "ACCESS_GUARDRAIL" ] }, "assignmentDescription":{ "description":"The description of the assignment.", "type":"string" }, "assignmentAttributes":{ "description":"The attributes of the assignment.", "type":"array", "items":{ "$ref":"#/definitions/AssignmentAttribute" } }, "recommendation":{ "description":"The risk level of the access review task.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/Recommendation", "enum":[ "ACCEPT", "REVIEW" ] }, "campaignName":{ "description":"The campaign name.", "type":"string" }, "daysRemaining":{ "description":"The number of days remaining.", "type":"integer" }, "accountType":{ "description":"The type of the account.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AccountType", "enum":[ "PRIMARY", "SERVICE" ] }, "timeGranted":{ "description":"The date this assignment was given.", "type":"string", "format":"date-time" }, "grantType":{ "description":"The type of grant mechanism.", "type":"string" }, "level":{ "description":"The reviewer level for this review task.", "type":"integer" }, "justificationRule":{ "description":"The justification rule for the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/JustificationType", "enum":[ "REQUIRE_FOR_ALL", "REQUIRE_FOR_REVOKE", "OPTIONAL_FOR_ALL" ] }, "templateType":{ "description":"The template type of the campaign.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/TemplateType", "enum":[ "IDENTITY", "AG_IDENTITY", "EVENT", "AG_EVENT", "CLOUD_PROVIDER", "POLICY", "IC_STRUCTURAL", "AG_POLICY", "GOVERNANCE_SYSTEM", "AG", "GOVERNANCE_SYSTEM_EVENT", "CLOUD_PROVIDER_EVENT" ] }, "campaignType":{ "description":"review task belongs to which campaign type (access or ownership).", "type":"string", "x-obmcs-top-level-enum":"#/definitions/CampaignType", "enum":[ "ACCESS", "OWNERSHIP" ] }, "delegatedBy":{ "description":"The task owner/reviewer.", "type":"string" }, "delegatedTo":{ "description":"The task delegated reviewer.", "type":"string" }, "hasSupportStatement":{ "description":"Flag indicating the review task has supporting policy statements or not.", "type":"boolean" }, "escalatedBy":{ "description":"The task owner/reviewer.", "type":"string" }, "escalatedTo":{ "$ref":"#/definitions/EscalationDetails" }, "isReassignable":{ "description":"Flag indicating whether the review task can be reassigned or not.", "type":"boolean" }, "reassignedBy":{ "description":"The task owner/reviewer display name of the original reviewer who reassigned the task.", "type":"string" }, "additionalAttributes":{ "$ref":"#/definitions/AdditionalAttributes" }, "timeExpiresPriorStage":{ "description":"The minimum date decided by reviewers from previous stages when access expires for the temporal access. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "timeMaxExpires":{ "description":"The current max expiration time that the temporal access is allowed to have.", "type":"string", "format":"date-time" }, "timeExpires":{ "description":"The current end date that the temporal access is set to expire. An RFC3339 formatted datetime string.", "type":"string", "format":"date-time" }, "isPriorStageAccessIndefinite":{ "description":"Whether the prior stage reviewer has chosen indefinite access.", "type":"boolean" } } }, "ChildType":{ "type":"string", "description":"Child type.", "enum":[ "ASSOCIATION", "CONDITION", "EXCLUDED", "INCLUDED", "PRIMARY", "NON_REVIEWABLE" ] }, "ChildId":{ "type":"object", "description":"The child ID object.", "required":[ "id", "type" ], "properties":{ "id":{ "description":"The ID of the child object.", "type":"string", "minLength":1, "maxLength":255 }, "type":{ "description":"The type of the child object.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ChildType", "enum":[ "ASSOCIATION", "CONDITION", "EXCLUDED", "INCLUDED", "PRIMARY", "NON_REVIEWABLE" ] } } }, "AcceptOrRevokeAccessReviewDetails":{ "type":"object", "description":"Details to accept or revoke the access review.", "properties":{ "justification":{ "description":"The justification for the decision.", "type":"string", "maxLength":500 }, "timeExpiresSelected":{ "description":"The current date that the temporal access is set to expire. An RFC3339 formatted datetime string. Only applicable to Permission review of an access bundle.", "type":"string", "format":"date-time" } } }, "ModifyAccessReviewDetails":{ "type":"object", "description":"Details to modify the access review. revokedChildIds and acceptedChildIds are mutually exclusive.", "properties":{ "justification":{ "description":"The justification for the decision.", "type":"string", "maxLength":500 }, "revokedChildIds":{ "type":"array", "description":"List of child ids that are revoked for given access review.", "items":{ "$ref":"#/definitions/ChildId" }, "maxItems":500 }, "acceptedChildIds":{ "type":"array", "description":"List of child ids that are accepted for given access review.", "items":{ "$ref":"#/definitions/ChildId" }, "maxItems":500 } } }, "UpdateOwnerAccessReviewDetails":{ "type":"object", "description":"Details to update owner of the access review.", "properties":{ "justification":{ "description":"The justification for the decision.", "type":"string", "maxLength":500 }, "identityId":{ "description":"Global Identity ID to whom this review task is reassigned or matched to Orphan account.", "type":"string", "minLength":1, "maxLength":255 } } }, "TextualExplanation":{ "type":"object", "description":"Textual explanation of review recommendation", "required":[ "explanation", "attributes" ], "properties":{ "explanation":{ "type":"string", "description":"Textual explanation" }, "attributes":{ "type":"array", "description":"Attributes of textual explanation", "items":{ "type":"string" }, "maxItems":4 } } }, "AccessReviewInsights":{ "type":"object", "description":"The insight information for the given access review.", "required":[ "version" ], "properties":{ "version":{ "type":"integer", "description":"The version of the insights format." }, "alignments":{ "type":"array", "description":"The list of alignment information.", "items":{ "$ref":"#/definitions/Alignment" } }, "insights":{ "type":"array", "description":"The list of insights.", "items":{ "$ref":"#/definitions/InsightAttribute" } }, "locationAlignments":{ "type":"array", "description":"The list of location alignment information.", "items":{ "$ref":"#/definitions/LocationAlignment" } }, "peerSimilarities":{ "type":"array", "description":"The list of peer similarities information.", "items":{ "$ref":"#/definitions/PeerSimilarity" } }, "identityCollectionMembership":{ "$ref":"#/definitions/IdentityCollectionMembership" }, "textualExplanations":{ "type":"array", "description":"The list of textual explanation.", "items":{ "$ref":"#/definitions/TextualExplanation" } } } }, "SourceType":{ "type":"string", "description":"The source of the event type.", "enum":[ "GLOBAL_IDENTITY", "OIG", "OCI", "ICF", "TARGET_IDENTITY", "AGCS" ] }, "AccessReviewEventChangesSummaryCollection":{ "type":"object", "description":"List of event change summaries.", "required":[ "items" ], "properties":{ "items":{ "description":"List of event change summaries.", "type":"array", "items":{ "$ref":"#/definitions/AccessReviewEventChangesSummary" } } } }, "AccessReviewEventChangesSummary":{ "type":"object", "description":"The event change associated with the given review task.", "required":[ "id", "displayName", "sourceType" ], "properties":{ "id":{ "type":"string", "description":"The id of the event change." }, "displayName":{ "description":"The display name of the event change.", "type":"string" }, "sourceType":{ "description":"The source type of the event change.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SourceType", "enum":[ "GLOBAL_IDENTITY", "OIG", "OCI", "ICF", "TARGET_IDENTITY", "AGCS" ] }, "timeChanged":{ "description":"The date that event change occurred.", "type":"string", "format":"date-time" }, "previousValue":{ "type":"string", "description":"The previous value." }, "currentValue":{ "type":"string", "description":"The current value." }, "format":{ "type":"string", "description":"The format of the value." } } }, "AuditReviewerAction":{ "type":"string", "description":"The action by the reviewer on an access review task.", "enum":[ "ACCEPT", "REVOKE", "MODIFY", "ASSIGN", "REMOVE", "REASSIGN", "REJECTED", "INITIAL_REQUEST", "APPROVED", "DELETED", "CANCELLED", "FAILED", "REQUEST_INFO", "PROVIDE_INFO", "CANCEL", "REJECT", "EXTENSION_REQUEST", "EXPIRE" ] }, "AccessReviewPriorActionsSummaryCollection":{ "type":"object", "description":"List of prior action summaries.", "required":[ "items" ], "properties":{ "items":{ "description":"List of prior action summaries.", "type":"array", "items":{ "$ref":"#/definitions/AccessReviewPriorActionsSummary" } } } }, "AccessReviewPriorActionsSummary":{ "type":"object", "description":"The prior action for the given review task.", "required":[ "campaignName", "reviewerName", "reviewerType", "action", "timeReviewed" ], "properties":{ "campaignName":{ "type":"string", "description":"The name of the campaign or event." }, "level":{ "type":"integer", "description":"The reviewer level." }, "reviewerName":{ "type":"string", "description":"The name of the reviewer or actor." }, "reviewerType":{ "description":"The type of the reviewer or actor.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ReviewerType", "enum":[ "CUSTOM_OWNER", "OWNER", "USER", "USER_MANAGER", "CLOUD_REVIEWER", "APPROVAL_SYSTEM", "REQUESTOR", "BENEFICIARY", "BENEFICIARY_MANAGER", "CUSTOM_USER", "GROUP", "MANAGER_CHAIN", "SYSTEM", "NO_APPROVAL" ] }, "action":{ "description":"The action that was taken by the reviewer.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AuditReviewerAction", "enum":[ "ACCEPT", "REVOKE", "MODIFY", "ASSIGN", "REMOVE", "REASSIGN", "REJECTED", "INITIAL_REQUEST", "APPROVED", "DELETED", "CANCELLED", "FAILED", "REQUEST_INFO", "PROVIDE_INFO", "CANCEL", "REJECT", "EXTENSION_REQUEST", "EXPIRE" ] }, "timeReviewed":{ "description":"The date that the reviewer took the action.", "type":"string", "format":"date-time" }, "isAutoActioned":{ "type":"boolean", "description":"Whether or not the review task was auto actioned." }, "isCompletionRuleActioned":{ "type":"string", "description":"Whether or not the review task was actioned by completion rule." }, "justification":{ "type":"string", "description":"The justification given by the reviewer." }, "finalAction":{ "type":"string", "description":"The final action for that stage/level for that review task." }, "subLevel":{ "type":"string", "description":"SubLevel will be the manager level in the management chain." }, "hasSodViolation":{ "type":"boolean", "description":"Whether or not there were SOD violations present." }, "additionalAttributes":{ "description":"Map for additional key, value Object pairs.", "type":"object", "additionalProperties":{ "type":"object" } } } }, "AgOrgSummary":{ "type":"object", "description":"Ag Org summary.", "required":[ "value", "displayName" ], "properties":{ "value":{ "description":"The Id of the Ag org.", "type":"string" }, "displayName":{ "description":"The name of the Ag org.", "type":"string" } } }, "IdentitySummaryCollection":{ "type":"object", "description":"List of identities.", "required":[ "items" ], "properties":{ "items":{ "description":"List of identities.", "type":"array", "items":{ "$ref":"#/definitions/IdentitySummary" } } } }, "IdNameObject":{ "type":"object", "description":"The Attribute key or Operator condition for the Membership rule.", "required":[ "id", "name", "displayName" ], "properties":{ "id":{ "description":"The ID of the Attribute Key or Operator.", "type":"string" }, "name":{ "description":"The name of the Attribute Key or Operator.", "type":"string" }, "displayName":{ "description":"The display name of the Attribute Key or Operator.", "type":"string" } } }, "AttributeCondition":{ "type":"object", "description":"The Attribute condition for the Membership rule.", "required":[ "id", "attrKey", "operator", "attrValue", "attrType" ], "properties":{ "id":{ "description":"The ID of the Membership rule condition.", "type":"string" }, "attrKey":{ "$ref":"#/definitions/IdNameObject" }, "operator":{ "$ref":"#/definitions/IdNameObject" }, "attrValue":{ "description":"The attribute value of the Membership rule condition.", "type":"string" }, "attrType":{ "description":"The attribute type of the Membership rule condition.", "type":"string" } } }, "MembershipRule":{ "type":"object", "description":"The Membership rule summary for the IC review.", "properties":{ "bindingOperator":{ "description":"The operator of the Membership rule.", "type":"string" }, "attributeConditions":{ "description":"The attribute conditions for the Membership rule.", "type":"array", "items":{ "$ref":"#/definitions/AttributeCondition" } } } }, "PolicyStatementSummaryCollection":{ "type":"object", "description":"List of policy statement summaries.", "required":[ "items" ], "properties":{ "items":{ "description":"List of policy statement summaries.", "type":"array", "items":{ "$ref":"#/definitions/PolicyStatementSummary" } } } }, "PolicyStatementSummary":{ "type":"object", "description":"The policy statement associated with the given access review.", "required":[ "id", "statement", "isActionable" ], "properties":{ "id":{ "type":"string", "description":"The id of the policy statement." }, "statement":{ "description":"The display name of the policy statement.", "type":"string" }, "isActionable":{ "description":"Is the policy statement actionable or not.", "type":"boolean" }, "position":{ "description":"The position order of the statement in the policy.", "type":"integer" } } }, "AssociationType":{ "type":"string", "description":"The association type of the access review.", "enum":[ "ROLE", "ACCESS_BUNDLE" ] }, "AssociationSummary":{ "type":"object", "description":"The Association summary for the access review.", "required":[ "id", "position" ], "properties":{ "id":{ "description":"The ID of the association.", "type":"string" }, "type":{ "description":"The type of the association.", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AssociationType", "enum":[ "ROLE", "ACCESS_BUNDLE" ] }, "identityCollections":{ "description":"The list of Identity Collections.", "type":"array", "items":{ "$ref":"#/definitions/IdNameObject" } }, "accesses":{ "description":"The list of AccessBundles or Roles.", "type":"array", "items":{ "$ref":"#/definitions/IdNameObject" } }, "position":{ "description":"The position of the statement in the association.", "type":"integer" } } }, "AssociationSummaryCollection":{ "type":"object", "description":"List of Associations.", "required":[ "items" ], "properties":{ "items":{ "description":"List of Associations.", "type":"array", "items":{ "$ref":"#/definitions/AssociationSummary" } } } }, "ConditionType":{ "type":"string", "description":"Child type", "enum":[ "EXCLUDED", "INCLUDED", "NON_REVIEWABLE" ] }, "PolicyStatement":{ "type":"object", "description":"The policy statement associated with the given review task.", "required":[ "id", "statement", "isActionable", "hasSubjectInsights", "hasLocationInsights", "hasResourceInsights" ], "properties":{ "id":{ "type":"string", "description":"The id of the policy statement." }, "statement":{ "description":"The policy statement.", "type":"string" }, "position":{ "description":"The position order of the statement in the policy.", "type":"integer" }, "isActionable":{ "description":"Is the policy statement actionable or not.", "type":"boolean" }, "hasSubjectInsights":{ "description":"Is the policy statement has subject insights or not.", "type":"boolean" }, "hasLocationInsights":{ "description":"Is the policy statement has location insights or not.", "type":"boolean" }, "hasResourceInsights":{ "description":"Is the policy statement has resource insights or not.", "type":"boolean" }, "notes":{ "type":"array", "description":"The list of policy notes from insights.", "items":{ "type":"string" } }, "verb":{ "description":"The privilege of the resources in the statement.", "type":"string" } } }, "ResourceDimensionType":{ "type":"string", "description":"Resource Dimension Type.", "enum":[ "RESOURCE_TYPE", "COMPARTMENT" ] }, "ResourceAggregationSummaryCollection":{ "type":"object", "description":"List of review aggregations.", "required":[ "items" ], "properties":{ "items":{ "description":"List of review aggregations.", "type":"array", "items":{ "$ref":"#/definitions/ResourceAggregationSummary" } } } }, "ResourceAggregationSummary":{ "type":"object", "description":"The aggregation based on the reviews.", "required":[ "dimension", "count" ], "properties":{ "dimension":{ "$ref":"#/definitions/ResourceDimension" }, "count":{ "description":"The count of matches for the aggregation.", "type":"integer" } } }, "ResourceDimension":{ "type":"object", "description":"The dimensions that are being aggregated on.", "required":[ "value" ], "properties":{ "value":{ "type":"string", "description":"Value represents the name based on ResourceDimensionType For example - resource_type like computes, databases etc. compartment names like test-compartment etc." }, "fullValue":{ "type":"string", "description":"Value represents the full name of compartment for ResourceDimensionType compartment, for other it will null or same as value." } } }, "PolicyStatementResourceSummaryCollection":{ "type":"object", "description":"List of policy statement Resource summaries.", "required":[ "items" ], "properties":{ "items":{ "description":"List of policy statement Resource summaries.", "type":"array", "items":{ "$ref":"#/definitions/PolicyStatementResourceSummary" } } } }, "PolicyStatementResourceSummary":{ "type":"object", "description":"The policy statement resource associated with the given policy statement.", "required":[ "id", "resourceName", "resourceType", "compartmentName", "compartmentFullName" ], "properties":{ "id":{ "type":"string", "description":"The id of the resource belonging to policy statement." }, "resourceName":{ "description":"The display name of the resource belonging to policy statement.", "type":"string" }, "resourceType":{ "description":"The type of resource belonging to policy statement.", "type":"string" }, "compartmentName":{ "description":"The resource compartment name belonging to policy statement.", "type":"string" }, "compartmentFullName":{ "description":"The resource compartment full name belonging to policy statement.", "type":"string" } } }, "PolicyStatementIdentitySummaryCollection":{ "type":"object", "description":"List of policy statement identity summaries.", "required":[ "items" ], "properties":{ "items":{ "description":"List of policy statement identity summaries.", "type":"array", "items":{ "$ref":"#/definitions/PolicyStatementIdentitySummary" } } } }, "PolicyStatementIdentitySummary":{ "type":"object", "description":"The policy statement identity associated with the given policy statement.", "required":[ "id", "name" ], "properties":{ "id":{ "type":"string", "description":"The id of the policy statement." }, "name":{ "description":"The user name of the policy identity.", "type":"string" }, "displayName":{ "description":"The display name of the policy identity.", "type":"string" }, "domainName":{ "description":"The domainName that policy subject belongs to.", "type":"string" }, "membership":{ "description":"The policy statement identity group name.", "type":"string" }, "email":{ "description":"The policy statement identity email.", "type":"string" } } } }, "parameters":{ "DisplayNameQueryParam":{ "name":"displayName", "in":"query", "description":"A filter to return only resources that match the entire display name given.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, "DownloadLimitQueryParam":{ "name":"downloadLimit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":1000, "maximum":10000, "minimum":1 }, "KeywordContainsQueryParam":{ "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, "LifecycleStateQueryParam":{ "name":"lifecycleState", "in":"query", "description":"A filter to return only resources their lifecycleState matches the given lifecycleState.", "required":false, "type":"string", "enum":[ "CREATING", "UPDATING", "ACTIVE", "DELETING", "DELETED", "FAILED" ], "x-obmcs-top-level-enum":"#/definitions/LifecycleState", "x-default-description":"null" }, "IfMatchHeader":{ "name":"if-match", "in":"header", "description":"For optimistic concurrency control. In the PUT or DELETE call\nfor a resource, set the `if-match` parameter to the value of the\netag from a previous GET or POST response for that resource.\nThe resource will be updated or deleted only if the etag you\nprovide matches the resource's current etag value.\n", "required":false, "type":"string" }, "NameQueryParam":{ "name":"name", "in":"query", "description":"A name to filter results\n", "required":false, "type":"string", "maxLength":100, "x-default-description":"null" }, "NameContainsQueryParam":{ "name":"nameContains", "in":"query", "description":"A filter to return only resources with name that matches the given keyword.", "required":false, "type":"string", "maxLength":100, "minLength":1, "x-default-description":"null" }, "PaginationLimitQueryParam":{ "name":"limit", "in":"query", "description":"The maximum number of items to return.", "required":false, "type":"integer", "default":10, "maximum":100, "minimum":1 }, "PaginationTokenQueryParam":{ "name":"page", "in":"query", "description":"A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response.", "required":false, "type":"string", "minLength":1, "x-default-description":"null" }, "RetryTokenHeader":{ "name":"opc-retry-token", "in":"header", "description":"A token that uniquely identifies a request so it can be retried in case of a timeout or\nserver error without risk of executing that same action again. Retry tokens expire after 24\nhours, but can be invalidated before then due to conflicting operations. For example, if a resource\nhas been deleted and purged from the system, then a retry of the original creation request\nmight be rejected.\n", "required":false, "type":"string", "maxLength":64, "minLength":1 }, "RequestIdHeader":{ "name":"opc-request-id", "in":"header", "description":"The client request ID for tracing. The only valid characters for request IDs are letters, numbers,\nunderscore, and dash.\n", "required":false, "type":"string" }, "TenancyIdHeader":{ "name":"tenancy-id", "in":"header", "description":"The tenancy id.", "required":false, "type":"string", "x-default-description":"null" }, "SortByQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ] }, "SortOrderQueryParam":{ "name":"sortOrder", "in":"query", "description":"The sort order to use, either 'ASC' or 'DESC'.", "required":false, "type":"string", "enum":[ "ASC", "DESC" ], "x-obmcs-top-level-enum":"#/definitions/SortOrders", "x-default-description":"The default value depends upon `sortBy`, and\nin general is 'DESC' when sorting by time and 'ASC' otherwise.\n" }, "OrchestratedSystemIdQueryParam":{ "name":"orchestratedSystemId", "in":"query", "description":"A filter to return only resources that match given orchestrated system identifier.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, "OrchestratedSystemStatusQueryParam":{ "name":"orchestratedSystemStatus", "in":"query", "description":"A filter to return only resources that have active orchestrated systems. \nA value of ACTIVE will return only active systems. \n", "required":false, "type":"string", "maxLength":255, "minLength":1, "enum":[ "ACTIVE" ], "x-default-description":"null" }, "UserIdQueryParam":{ "name":"userId", "in":"query", "description":"Identifier of the user who is performing the operation", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, "OrchestratedSystemIdPathParam":{ "name":"orchestratedSystemId", "in":"path", "description":"The unique id for an Orchestrated System. Available values can be found using the ListOrchestratedSystems operation.", "required":true, "type":"string" }, "DisplayNameListQueryParam":{ "name":"displayName", "in":"query", "description":"A filter to return only resources that match the given display names.", "required":false, "type":"array", "items":{ "type":"string" }, "collectionFormat":"multi", "x-default-description":"null" }, "OrchestratedSystemLifecycleStateListQueryParam":{ "name":"lifecycleState", "in":"query", "description":"A filter to return only orchestrated systems that match the given lifecycle states.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "ACTIVE", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemLifecycleState" }, "collectionFormat":"multi", "x-default-description":"null" }, "OrchestratedSystemTypeListQueryParam":{ "name":"orchestratedSystemType", "in":"query", "description":"A filter to return only orchestrated systems that match the given types.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "OIG", "OCI", "AZUREAD", "DBUMORADB", "SALESFORCE", "SERVICENOW", "EBSUM", "EBSHRMS", "FA", "MSFTAD", "OID", "OUD", "DBUMMYSQL", "DBUMDB2", "MSTEAMS", "ELOQUA", "NETSUITE", "DBUMMSSQL", "EXPRESSFLATFILE", "GRC", "SIEBELUM", "PRIMAVERA", "PEOPLESOFT", "DBATORACLE", "ARCONPAM", "CERNERMILLENNIUM", "DBATMYSQL", "DBATMSSQL", "CERNERHI", "ZOOM", "JIRA", "WORKDAY", "SAPARIBA", "SUCCESSFACTORS", "SAPS4HANA", "SAPFIELDGLASS", "BEYONDTRUST", "ORACLEEPM", "SAPUM", "DBUMPOSTGRESQL", "AWS", "GOTOMEETING", "ORACLEAPEX", "ORACLECPQ", "ORACLEUNITY", "ORACLEOTMGTM", "ORACLEINFINITY", "WEBEX", "FALEARNING", "ORACLEWMS", "PANPRISMA", "GRCDIRECTCONFIG" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemType" }, "collectionFormat":"multi", "x-default-description":"null" }, "OrchestratedSystemModeQueryParam":{ "name":"mode", "in":"query", "description":"A filter to return only orchestrated systems based onthe given modes.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "AUTHORITATIVE", "NONAUTHORITATIVE", "BOTH", "NONE", "SOURCE_OF_IDENTITY_ATTRIBUTE", "BOTH_SOURCE_OF_IDENTITY_ATTRIBUTE" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystem" }, "collectionFormat":"multi", "x-default-description":"null" }, "IsIdentityCollectionQueryParam":{ "name":"isIdentityCollectionSupported", "in":"query", "description":"A filter to return Orchestrated Systems where identity are managed using identity collection.", "required":false, "type":"boolean", "x-default-description":"null" }, "IsSchemaDiscoverySupportedQueryParam":{ "name":"isSchemaDiscoverySupported", "in":"query", "description":"A filter to return Orchestrated Systems that support schema discovery operation.", "required":false, "type":"boolean", "x-default-description":"null" }, "IsOrchestratedSystemActivatedQueryParam":{ "name":"isOrchestratedSystemActivated", "in":"query", "description":"A filter to return Orchestrated Systems that are activated.", "required":false, "type":"boolean", "x-default-description":"null" }, "OwnerIdQueryParam":{ "name":"ownerId", "in":"query", "description":"A filter to return only resources that are owned by the user.", "required":false, "type":"string", "x-default-description":"null" }, "OrchestratedSystemSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending.\nDefault order for displayName is ascending.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName" ], "x-obmcs-top-level-enum":"#/definitions/OrchestratedSystemSortBy" }, "PermissionTypeIdQueryParam":{ "name":"permissionTypeId", "in":"query", "description":"The id of the permission type that the permissions are attached to.", "required":false, "type":"string", "x-default-description":"null" }, "RequestableByQueryParam":{ "name":"requestableBy", "in":"query", "description":"A filter to return only resources that match given identityType.", "required":false, "type":"string", "enum":[ "NONE", "ANY" ], "x-obmcs-top-level-enum":"#/definitions/IdentityType", "x-default-description":"null" }, "DomainNameQueryParam":{ "name":"domainName", "in":"query", "description":"Domain Name", "required":false, "type":"string", "x-default-description":"domainName" }, "ResourceTypeQueryParam":{ "name":"resourceType", "in":"query", "description":"The resource type filter to fetch permissions for OCI systems. Required when orchestratedSystem type is OCI.\n", "required":false, "type":"string", "enum":[ "APP_ROLE", "GROUP" ], "x-obmcs-top-level-enum":"#/definitions/PermissionResourceType", "x-default-description":"null" }, "LookupTypeIdentifierQueryParam":{ "name":"lookupType", "in":"query", "description":"The lookup Id of the resource we want to request", "required":true, "type":"string" }, "LookupKeywordContainsQueryParam":{ "name":"keywordContains", "in":"query", "description":"Keyword to filter on from the following fields: label. Only one keyword may be provided.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided." }, "PermissionsKeywordContainsQueryParam":{ "name":"keywordContains", "in":"query", "description":"Keyword to filter on from the following fields: displayName. Only one keyword may be provided.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided." }, "OrchestratedSystemKeywordContainsQueryParam":{ "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on from the following fields: displayName, lifecycleState.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, "AccountProfileIdentifierPathParam":{ "name":"accountProfileId", "in":"path", "description":"Unique AccountProfile identifier.", "required":true, "type":"string" }, "AccountProfileIsDefaultOnlyQueryParam":{ "name":"isDefaultOnly", "in":"query", "description":"Parameter to request only the default AccountProfile be returned.", "required":false, "type":"boolean", "default":false, "maxLength":255, "minLength":1 }, "AccountProfileKeywordContainsQueryParam":{ "name":"keywordContains", "in":"query", "description":"The list of keywords to filter on from the following fields: displayName, description.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, "AccountProfileSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "timeCreated", "displayName", "timeLastModified" ], "x-obmcs-top-level-enum":"#/definitions/AccountProfileSortBy" }, "OrganizationLifecycleStateQueryParam":{ "name":"status", "in":"query", "description":"A filter to return only organizations that match the give status or ALL to match all organizations.", "required":false, "type":"string", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ], "x-default-description":"null" }, "OrganizationSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided. Default order for timeUpdated is descending. Default order for name is ascending.\n", "required":false, "type":"string", "enum":[ "createdBy", "displayName", "name", "timeUpdated" ], "x-obmcs-top-level-enum":"#/definitions/OrganizationSortBy", "x-default-description":"null" }, "OrganizationIdPathParam":{ "name":"organizationId", "in":"path", "description":"The unique id for an Organization. Available values can be found using the ListOrganizations operation.", "required":true, "type":"string" }, "SingleKeywordContainsQueryParam":{ "name":"keywordContains", "in":"query", "description":"Keyword to filter on. Only one keyword may be provided. Default is empty string.\n", "required":false, "type":"string", "x-default-description":"Keyword to filter on. Only one keyword may be provided. Default is empty string." }, "SortByPmQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided.", "required":false, "type":"string", "default":"timeCreated", "enum":[ "name", "timeCreated", "timeUpdated" ], "x-obmcs-top-level-enum":"#/definitions/SortByPm" }, "SortByIdentityQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Only one sort order may be provided.", "required":false, "type":"string", "default":"displayName", "enum":[ "timeCreated", "timeUpdated", "username", "displayName" ], "x-obmcs-top-level-enum":"#/definitions/SortByIdentity" }, "ApprovalWorkflowIdQueryParam":{ "name":"approvalWorkflowId", "in":"query", "description":"A filter to return only resources that match the given approval workflow id.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, "ApprovalProcessStateOptionalQueryParam":{ "name":"state", "in":"query", "description":"A filter to return only the workflows that match the given approval process state.", "required":false, "type":"string", "enum":[ "DRAFT", "PUBLISHING", "ACTIVE", "DISABLED", "DELETING" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessState", "x-default-description":"If not specified, all matching approval processes are provided regardless of state." }, "StatusQueryParam":{ "name":"status", "in":"query", "description":"A filter to be used for finding entities with the given status.\n", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "ACTIVE", "DRAFT", "INACTIVE" ], "x-obmcs-top-level-enum":"#/definitions/Status" }, "InsightsQueryParam":{ "name":"insights", "in":"query", "description":"Boolean query param to pass if extra data is required or not\n", "required":false, "type":"boolean", "default":false }, "OrganizationIdQueryParam":{ "name":"organizationId", "in":"query", "description":"A filter to return only resources that match the given organization id.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, "AccessBundleIdPathParam":{ "name":"accessBundleId", "in":"path", "description":"A filter to be used for finding Access Bundles with the given id. \nAvailable values can be found using the ListAccessBundles operation.\n", "required":true, "type":"string" }, "AccessBundleSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"A filter to be used for sorting Access Bundles with the given sort by field. \nOnly one sort order may be provided. \n", "required":false, "type":"string", "default":"timeUpdatedOn", "enum":[ "name", "timeUpdated", "createdBy" ], "x-obmcs-top-level-enum":"#/definitions/AccessBundleSortBy" }, "LookUpTypeQueryParam":{ "name":"lookupType", "in":"query", "description":"A filter to be used for finding lookup values for the given lookup type.\n", "required":true, "type":"string" }, "OwnerIdOptionalQueryParam":{ "name":"ownerId", "in":"query", "description":"Owner ID to filter on", "required":false, "type":"string" }, "ApprovalProcessSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Default sort by is displayName. \n", "required":false, "type":"string", "default":"displayName", "enum":[ "displayName", "state", "creatorId", "timeCreated" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessSortBy" }, "ApprovalProcessIdOptionalQueryParam":{ "name":"processId", "in":"query", "description":"The approval process ID to filter on. If specified all existing versions of the approval process are provided.", "required":false, "type":"string", "x-default-description":"If not specified, the draft and latest versions of all approval processes are provided." }, "ApprovalProcessOutOfBoxCategoryOptionalQueryParam":{ "name":"outOfBoxCategory", "in":"query", "description":"Indicates the category of out of box workflow to filter on. If specified, 'isOutOfBox' is assumed true and 'isTransition' is ignored.", "required":false, "type":"string", "enum":[ "UNMATCHED", "OWNERSHIP", "TRANSITION" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalProcessOutOfBoxCategory", "x-default-description":"If not specified, null is assumed." }, "RequestedAfterQueryParam":{ "name":"timeRequestedAfter", "in":"query", "description":"Return only instances created after the specified date.", "required":false, "type":"string", "format":"date-time", "x-default-description":"If not specified, the requestedAfter filter will not be applied." }, "RequestSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Default sort by is timeCreated.\n", "required":false, "type":"string", "default":"timeCreated", "enum":[ "requestor", "beneficiary", "status", "timeCreated", "assignmentName", "assignmentType" ], "x-obmcs-top-level-enum":"#/definitions/RequestSortBy" }, "InstanceIdPathParam":{ "name":"instanceId", "in":"path", "description":"Unique Instance identifier.", "required":true, "type":"string" }, "RequestorIdQueryParam":{ "name":"requestorId", "in":"query", "description":"A filter to return only resources that have the passed in requestorId.", "required":false, "type":"string", "maxLength":255, "minLength":1, "x-default-description":"null" }, "AccessRequestIdentifierPathParam":{ "name":"accessRequestId", "in":"path", "description":"Unique AccessRequest identifier", "required":true, "type":"string" }, "TaskAssigneeIdOptionalQueryParam":{ "name":"assigneeId", "in":"query", "description":"The global id for the assignee to filter on. \nThis parameter is required when an accessRequestId is not provided.\n", "required":false, "type":"string" }, "TaskAssigneeScopeOptionalQueryParam":{ "name":"assigneeScope", "in":"query", "description":"Assignee scope to filter on. \n'DIRECT' to filter on the tasks where the assignee id or authenticated user is the direct assignee,\nor 'INDIRECT' to filter on the tasks where the assignee has indirect approval rights.\n", "required":false, "type":"string", "enum":[ "DIRECT", "INDIRECT" ], "x-obmcs-top-level-enum":"#/definitions/TaskAssigneeScope", "x-default-description":"If not specified, results will contain both direct & indirect assignee scopes." }, "AccessRequestIdOptionalQueryParam":{ "name":"accessRequestId", "in":"query", "description":"The access request id to filter on. This parameter is required when assigneeId is not provided. \n", "required":false, "type":"string" }, "TaskStatusOptionalQueryParam":{ "name":"status", "in":"query", "description":"List of task statuses to filter on.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "PENDING_APPROVAL", "APPROVED", "ASSIGNED", "MODIFIED", "REJECTED", "REMOVED", "DELETED", "INFO_REQUESTED", "ESCALATED", "ERROR", "CANCELLED" ], "x-obmcs-top-level-enum":"#/definitions/TaskStatus" }, "collectionFormat":"multi", "x-default-description":"If not specified, will default to PENDING_APPROVAL, INFO_REQUESTED, and ESCALATED." }, "DueBeforeOptionalQueryParam":{ "name":"dueBefore", "in":"query", "description":"Return only tasks due before the specified date.", "required":false, "type":"string", "format":"date-time", "x-default-description":"If not specified, the dueBefore filter will not be applied." }, "RequestedAfterOptionalQueryParam":{ "name":"requestedAfter", "in":"query", "description":"Return only instances created after the specified date.", "required":false, "type":"string", "format":"date-time", "x-default-description":"If not specified, the requestedAfter filter will not be applied." }, "TaskKeywordContainsOptionalQueryParam":{ "name":"keywordContains", "in":"query", "description":"Keyword to use to filter against the names of the requestor and beneficiary.", "required":false, "type":"string", "x-default-description":"If not specified, the keywords filter will not be applied." }, "InstanceTagsOptionalQueryParam":{ "name":"instanceTags", "in":"query", "description":"List of tag filters to use.\nEach position in the array maps to the tag in the InstanceTags enum that is in the same position.\nSet the value to true to include instances that carry the tag.\nSet the value to false to exclude instances that carry the tag.\nSet the value to null in order to not apply the filter.\n", "required":false, "type":"array", "items":{ "type":"boolean" }, "collectionFormat":"multi", "x-default-description":"If not specified, the instance tags filter will not be applied." }, "TaskSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"The field to sort by. Default sort by is 'dueDate'.\n", "required":false, "type":"string", "enum":[ "requestor", "beneficiary", "dueDate", "access" ], "x-default-description":"If not specified, sorting will be by due date." }, "TaskIdPathParam":{ "name":"taskId", "in":"path", "description":"Unique approval task identifier.", "required":true, "type":"string" }, "WorkRequestIdPathParam":{ "name":"workRequestId", "in":"path", "description":"Unique work request identifier.", "required":true, "type":"string" }, "ApprovalTypeFilterOptionalQueryParam":{ "name":"type", "in":"query", "description":"Approval type filters for listing and counting approvals.", "required":false, "type":"string", "default":"ALL_EXCEPT_ACCESS_REVIEWS", "enum":[ "ACCESS_REQUESTS_ONLY", "REQUESTS_FOR_ACCESS_ONLY", "REVISION_REQUESTS_ONLY", "ALL_EXCEPT_ACCESS_REVIEWS" ], "x-obmcs-top-level-enum":"#/definitions/ApprovalTypeFilter" }, "AssignmentTypeOptionalQueryParam":{ "name":"assignmentType", "in":"query", "description":"The type of assignment the approval is for.", "required":false, "type":"string", "enum":[ "ACCESS_BUNDLE", "ROLE", "IDENTITY_GROUP", "ACTIVE_GROUP", "CONSUMER_GROUP", "AG_ORGANIZATION" ], "x-obmcs-top-level-enum":"#/definitions/AssignmentType", "x-default-description":"If not specified, the assumption is the approval is for an access request." }, "AccessGuardrailIdentifierPathParam":{ "name":"accessGuardrailId", "in":"path", "description":"Unique Access Guardrail identifier", "required":true, "type":"string" }, "RoleIdentifierPathParam":{ "name":"roleId", "in":"path", "description":"Unique Role identifier", "required":true, "type":"string" }, "RoleSortByQueryParam":{ "name":"sortBy", "in":"query", "description":"A filter to be used for sorting Roles with the given sort by field. \nOnly one sort order may be provided.\n", "required":false, "type":"string", "default":"timeUpdatedOn", "enum":[ "name", "timeUpdated", "createdBy" ], "x-obmcs-top-level-enum":"#/definitions/RoleSortBy" }, "PolicyIdPathParam":{ "name":"policyId", "in":"path", "description":"Unique Policy identifier", "required":true, "type":"string" }, "PermissionIdPathParam":{ "name":"permissionId", "in":"path", "description":"A permission identifier.\n", "required":true, "type":"string" }, "IdentityCollectionIdentifierPathParam":{ "name":"identityCollectionId", "in":"path", "description":"Unique Identity Collection identifier", "required":true, "type":"string" }, "IdentityGroupIdentifierQueryParam":{ "name":"identityGroupId", "in":"query", "description":"Unique Identity group identifier", "required":true, "type":"string" }, "IdentityGroupMembershipRule":{ "name":"membershipRule", "in":"query", "description":"Membership Rule", "required":true, "type":"string" }, "ManagedAtOrchestratedSystemQueryParam":{ "name":"isManagedAtTargetOrchestratedSystem", "in":"query", "description":"If true will return ICs managed at orchestratedSystem", "required":false, "type":"boolean", "default":false }, "IdentityIdQueryParam":{ "name":"identityId", "in":"query", "description":"The ID of the resource that the permissions are attached to.", "required":false, "type":"string", "x-default-description":"null" }, "AccountIdPathParam":{ "name":"accountId", "in":"path", "description":"Unique Account id.", "required":true, "type":"string" }, "AttributeQueryParam":{ "name":"attributes", "in":"query", "description":"The list of Attributes used to filter.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, "AttributeValueQueryParam":{ "name":"attributeValues", "in":"query", "description":"A list of attribute values to use as matching filters.\n", "required":false, "type":"array", "items":{ "type":"string", "maxLength":100 }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, "BindingOperatorQueryParam":{ "name":"bindingOperator", "in":"query", "description":"A parameter to bind expressions.", "required":false, "type":"string", "default":"ALL", "enum":[ "ALL", "ANY" ], "x-obmcs-top-level-enum":"#/definitions/BindingOperator" }, "IdentityConsumerFilterQueryParam":{ "name":"consumerFilter", "in":"query", "description":"A filter for consumer/workforce types.", "required":false, "type":"string", "enum":[ "CONSUMER", "WORKFORCE" ], "x-obmcs-top-level-enum":"#/definitions/IdentityConsumerFilterTypes", "x-default-description":"Default behavior includes all types" }, "IdentityIdPathParam":{ "name":"identityId", "in":"path", "description":"Unique Identity id.", "required":true, "type":"string" }, "OperatorQueryParam":{ "name":"operators", "in":"query", "description":"A parameter to form logical expressions.", "required":false, "type":"array", "items":{ "type":"string", "enum":[ "EQ", "NE", "GT", "LT", "GTE", "LTE", "BEFORE", "AFTER", "TO", "FROM", "CONTAINS", "NOT_CONTAINS" ], "x-obmcs-top-level-enum":"#/definitions/Operator" }, "collectionFormat":"multi", "maxItems":5, "x-default-description":"null" }, "AttributeTypeQueryParam":{ "name":"attributeType", "in":"query", "description":"Attribute Type Query Param", "required":false, "type":"string", "default":"All" }, "AttributesTypeQueryParam":{ "name":"attributesType", "in":"query", "description":"The type of attributes", "required":false, "type":"string", "enum":[ "FULL", "CUSTOM_ON_IDENTITY_PAGE", "CUSTOM_CAMPAIGN_SELECTION", "CUSTOM_CAMPAIGN_EVENT", "CUSTOM_IDENTITY_LIFE_CYCLE", "CUSTOM_ON_MATCHING_RULES", "CUSTOM_ON_MAPPING_RULES", "CUSTOM_ON_ENTITY_VIEW", "OWNERSHIP_CAMPAIGN_VIEW" ], "x-obmcs-top-level-enum":"#/definitions/AttributesType", "x-default-description":"FULL" }, "AttributesNamespaceQueryParam":{ "name":"attributesNamespace", "in":"query", "description":"The namespace of attributes", "required":false, "type":"string", "enum":[ "ALL", "DEFAULTS", "CUSTOM", "AFFILIATION", "ALL_NO_AFFILIATION" ], "x-obmcs-top-level-enum":"#/definitions/AttributesNamespace", "x-default-description":"ALL" }, "IdentityAttributeIdPathParam":{ "name":"identityAttributeId", "in":"path", "description":"Identity attribute Id in path", "required":true, "type":"string" }, "TypeIdPathParam":{ "name":"typeId", "in":"path", "description":"The Type Id of an entity.", "required":true, "type":"string" }, "CampaignIdPathParam":{ "name":"campaignId", "type":"string", "in":"path", "required":true, "description":"Unique Campaign identifier." }, "TemplateIdQueryParam":{ "name":"templateId", "type":"string", "in":"query", "x-default-description":"null", "description":"The templateId in the given stage of the campaign." }, "StageIdPathParam":{ "name":"stageId", "type":"string", "in":"path", "required":true, "description":"The stage identifier for the given campaign." }, "CampaignStatusParam":{ "name":"status", "description":"The status of the campaign.", "type":"string", "in":"query", "required":false, "x-default-description":"null", "x-obmcs-top-level-enum":"#/definitions/CampaignState", "enum":[ "DRAFT", "SCHEDULED", "IN_PROGRESS", "READY_FOR_APPROVAL", "APPROVED", "TERMINATED", "SYSTEM_ABORTED" ] }, "TerminateTypeQueryParam":{ "name":"type", "in":"query", "type":"string", "required":false, "x-obmcs-top-level-enum":"#/definitions/TerminateType", "enum":[ "INSTANCE", "SERIES" ], "description":"The termination type.", "x-default-description":"INSTANCE" }, "SystemCriteriaStateQueryParam":{ "name":"state", "type":"string", "x-obmcs-top-level-enum":"#/definitions/SystemCriteriaState", "enum":[ "AVAILABLE", "NOT_AVAILABLE" ], "in":"query", "required":false, "description":"The state of system criteria type.", "x-default-description":"null" }, "AgEntityTypePathParam":{ "name":"agEntityType", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AgEntityType", "enum":[ "ACCESS_BUNDLES", "ACCESS_GUARDRAILS", "APPROVAL_WORKFLOWS", "IDENTITY_COLLECTIONS", "ORCHESTRATED_SYSTEMS", "POLICIES", "ROLES" ], "in":"path", "required":true, "description":"The type of entity to retrieve attributes for." }, "LocaleQueryParam":{ "name":"locale", "type":"string", "in":"query", "required":false, "description":"Locale used for translating attribute titles.", "x-default-description":"If not specified in the query, Accept-Language will be used for translations" }, "AttributeIdPathParam":{ "name":"attributeId", "type":"string", "in":"path", "required":true, "description":"ID of the Entity Attribute Id to retrieve the attribute values/info." }, "ListResourcesDetails":{ "name":"ListResourcesDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/KeywordFilteredDetails" } }, "ListPermissionsDetails":{ "name":"ListPermissionsDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/KeywordFilteredDetails" } }, "ListRolesDetails":{ "name":"ListRolesDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/FilteredDetails" } }, "ListPoliciesDetails":{ "name":"ListPoliciesDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/KeywordFilteredDetails" } }, "ListIdentityCollectionsDetails":{ "name":"ListIdentityCollectionsDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/KeywordFilteredDetails" } }, "PermissionTypeQueryParam":{ "name":"permissionType", "in":"query", "required":false, "type":"string", "description":"The type of permission.", "x-default-description":"null" }, "ListCloudProvidersDetails":{ "name":"ListCloudProvidersDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/KeywordFilteredDetails" } }, "ListCompartmentsDetails":{ "name":"ListCompartmentsDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/FilteredDetails" } }, "ListDomainsDetails":{ "name":"ListDomainsDetails", "description":"The filters to apply.", "in":"body", "required":true, "schema":{ "$ref":"#/definitions/CriteriaDetails" } }, "CustomAttributeIdPathParam":{ "name":"customAttributeId", "in":"path", "required":true, "type":"string", "description":"Custom attribute Id in path." }, "ListCustomAttributeDetails":{ "name":"ListCustomAttributeDetails", "description":"The filters to apply.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/KeywordFilteredDetails" } }, "PaginationExpandedLimitQueryParam":{ "name":"limit", "in":"query", "type":"integer", "minimum":1, "maximum":1000, "default":10, "description":"The maximum number of items to return." }, "ListAccessReviewsUserIdQueryParam":{ "in":"query", "maxLength":255, "minLength":1, "name":"userId", "type":"string", "required":true, "x-default-description":"null", "description":"Identifier of the user who is performing the operation." }, "IdentityReviewSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "x-obmcs-top-level-enum":"#/definitions/IdentityReviewSortBy", "enum":[ "entityName", "assignmentName", "managerName", "recommendation", "daysRemaining", "campaignName", "appNames", "identityAttributes" ], "default":"entityName", "description":"The field to sort by. The default value will be entityName.\n" }, "AccessControlReviewSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "x-obmcs-top-level-enum":"#/definitions/AccessControlReviewSortBy", "enum":[ "owner", "assignmentName", "recommendation", "daysRemaining", "campaignName" ], "default":"assignmentName", "description":"The field to sort by. The default value will be assignmentName.\n" }, "OwnershipReviewSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "x-obmcs-top-level-enum":"#/definitions/OwnershipReviewSortBy", "enum":[ "owner", "assignmentName", "daysRemaining", "campaignName" ], "default":"assignmentName", "description":"The field to sort by. The default value will be assignmentName.\n" }, "PolicyStatementSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "position" ], "default":"position", "description":"The field to sort by. The default value is position.\n" }, "AccessReviewIdPathParam":{ "name":"accessReviewId", "type":"string", "in":"path", "required":true, "description":"Unique access review identifier." }, "AcceptAccessReviewDetails":{ "name":"AcceptAccessReviewDetails", "description":"Details to accept the Access Review.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/AcceptOrRevokeAccessReviewDetails" } }, "RevokeAccessReviewDetails":{ "name":"RevokeAccessReviewDetails", "description":"Details to revoke the Access Review.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/AcceptOrRevokeAccessReviewDetails" } }, "ModifyAccessReviewDetails":{ "name":"ModifyAccessReviewDetails", "description":"Details to modify the Access Review.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/ModifyAccessReviewDetails" } }, "AssignAccessReviewDetails":{ "name":"AssignAccessReviewDetails", "description":"Details to assign the Access Review.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateOwnerAccessReviewDetails" } }, "RemoveAccessReviewDetails":{ "name":"RemoveAccessReviewDetails", "description":"Details to remove the Access Review.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/AcceptOrRevokeAccessReviewDetails" } }, "ReassignAccessReviewDetails":{ "name":"ReassignAccessReviewDetails", "description":"Details to reassign the Access Review.", "required":true, "in":"body", "schema":{ "$ref":"#/definitions/UpdateOwnerAccessReviewDetails" } }, "EventChangeSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "id", "displayName", "timeChanged" ], "default":"displayName", "description":"The sort by parameter for event changes and default value is displayName.\n" }, "PriorActionSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "campaignName", "reviewerName", "reviewerType", "timeReviewed", "action" ], "default":"timeReviewed", "description":"The sort by parameter for prior actions and default value is timeReviewed.\n" }, "AssociationSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "position" ], "default":"position", "description":"The sort by for associations. The default value is position." }, "PolicyStatementIdPathParam":{ "name":"policyStatementId", "type":"string", "in":"path", "required":true, "description":"Unique policy statement identifier." }, "ResourceDimensionTypeQueryParam":{ "name":"type", "in":"query", "type":"string", "x-obmcs-top-level-enum":"#/definitions/ResourceDimensionType", "enum":[ "RESOURCE_TYPE", "COMPARTMENT" ], "default":"RESOURCE_TYPE", "description":"The parameter for resource dimension type. The default value is RESOURCE_TYPE.\n" }, "ResourceGroupByQueryParam":{ "name":"groupBy", "required":true, "in":"query", "type":"string", "enum":[ "type" ], "description":"The group by field for policy resources." }, "PolicyResourceSortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "resourceName", "resourceType", "compartmentName" ], "default":"resourceName", "description":"The parameter for policy resources sortBy. The default value is resourceName.\n" }, "ReviewSortByAttributeQueryParam":{ "name":"sortByAttribute", "in":"query", "type":"string", "default":null, "x-default-description":"Defaults to null.", "description":"The field to sort by for Identity attributes.\n" }, "ConditionTypeQueryParam":{ "name":"type", "in":"query", "required":true, "type":"string", "x-obmcs-top-level-enum":"#/definitions/ConditionType", "enum":[ "EXCLUDED", "INCLUDED", "NON_REVIEWABLE" ], "description":"The type of member identity." }, "PolicyIdentitySortByQueryParam":{ "name":"sortBy", "in":"query", "type":"string", "enum":[ "displayName", "domainName", "membership", "email" ], "default":"displayName", "description":"The field to sort by. The default value is displayName.\n" } }, "responses":{ "400":{ "description":"Bad Request", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "401":{ "description":"Unauthorized", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "404":{ "description":"Not Found", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "409":{ "description":"Conflict", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "412":{ "description":"Precondition failed", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "429":{ "description":"Too Many Requests", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "500":{ "description":"Internal Server Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } }, "default":{ "description":"Unknown Error", "schema":{ "$ref":"#/definitions/Error" }, "headers":{ "opc-request-id":{ "type":"string", "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n" } } } }, "x-obmcs-issue-routing-table":{ "default":{ "phonebookId":"agcs", "email":"oci_agcs_ww_grp@oracle.com", "jiraProject":"AGCS", "opsJiraProject":"AGCS", "githubUsers":[ "danhill", "vshlapko" ] } }, "x-obmcs-client-retries-enabled":true, "x-obmcs-endpoint-template":"https://idm-agcs-api-ext.{region}.oci.{secondLevelDomain}", "x-anchors":{ "x-headers":{ "etag":{ "description":"For optimistic concurrency control. See `if-match`.\n", "type":"string" }, "opc-next-page":{ "description":"For pagination of a list of items. When paging through a list, if this header appears in the response,\nthen a partial list might have been returned. Include this value as the `page` parameter for the\nsubsequent GET request to get the next batch of items.\n", "type":"string" }, "opc-request-id":{ "description":"Unique Oracle-assigned identifier for the request. If you need to contact\nOracle about a particular request, please provide the request ID.\n", "type":"string" } }, "x-properties":{ "definedTags":{ "type":"object", "additionalProperties":{ "type":"object", "additionalProperties":{ "type":"object" } }, "description":"Defined tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`\n" }, "freeformTags":{ "type":"object", "additionalProperties":{ "type":"string" }, "description":"Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.\nExample: `{\"bar-key\": \"value\"}`\n" }, "systemTags":{ "type":"object", "additionalProperties":{ "type":"object", "additionalProperties":{ "type":"object" } }, "description":"System tags for this resource. Each key is predefined and scoped to a namespace.\nExample: `{\"orcl-cloud\": {\"free-tier-retained\": \"true\"}}`\n" } } }, "x-oracle-package":"com.oracle.idm.agcs.sa.api.ext", "x-obmcs-use-shared-work-requests-service":false, "tags":[ { "name":"AccessBundles", "description":"The operations from the AccessBundles category." }, { "name":"AccessGuardrails", "description":"The operations from the AccessGuardrails category." }, { "name":"AccessRequests", "description":"The operations from the AccessRequests category." }, { "name":"AccessReviews", "description":"Access Reviews that checks and certifies if privileges granted are still required and align with the current job at work" }, { "name":"ApprovalWorkflows", "description":"The operations from the ApprovalWorkflows category." }, { "name":"Approvals", "description":"The operations from the Approvals category." }, { "name":"Campaigns", "description":"The operations from the Campaigns category." }, { "name":"Identities", "description":"Identities in Access Governance" }, { "name":"IdentityCollections", "description":"The operations from the IdentityCollections category." }, { "name":"OrchestratedSystems", "description":"The operations from the OrchestratedSystems category." }, { "name":"Organizations", "description":"The operations from the Organizations category." }, { "name":"Permissions", "description":"The operations from the Permissions category." }, { "name":"Policies", "description":"The operations from the Policies category." }, { "name":"Roles", "description":"The operations from the Roles category." }, { "name":"SeparationOfDuties", "description":"The operations from the SeparationOfDuties category." }, { "name":"Types", "description":"The operations from the Types category." } ] }