{ "opencollection": "1.0.0", "info": { "name": "Managed Access Access Request API", "version": "20220126" }, "items": [ { "info": { "name": "accessRequest", "type": "folder" }, "items": [ { "info": { "name": "Retrieves a list of all access requests in a compartment.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220126/accessRequests", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "lockboxId", "value": "", "type": "query", "description": "The unique identifier (OCID) of the associated lockbox." }, { "name": "id", "value": "", "type": "query", "description": "A generic Id query param used to filter lockbox, access request and approval template by Id." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "lockboxPartner", "value": "", "type": "query", "description": "The name of the lockbox partner." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner." }, { "name": "requestorId", "value": "", "type": "query", "description": "The unique identifier (OCID) of the requestor in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "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" }, { "name": "timeCreatedAfter", "value": "", "type": "query", "description": "Date and time on or after which Access Requests were created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" }, { "name": "timeCreatedBefore", "value": "", "type": "query", "description": "Date and time on or before which Access requests were created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339)" } ] }, "docs": "Retrieves a list of AccessRequestSummary objects in a compartment.\n" }, { "info": { "name": "Creates a new access request.", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220126/accessRequests", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new access request.\n" }, { "info": { "name": "Get the full list of AccessRequests in a compartment in binary format", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220126/accessRequests/actions/export", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "id", "value": "", "type": "query", "description": "A generic Id query param used to filter lockbox, access request and approval template by Id." }, { "name": "displayName", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to return only resources their lifecycleState matches the given lifecycleState." }, { "name": "lockboxPartner", "value": "", "type": "query", "description": "The name of the lockbox partner." }, { "name": "partnerId", "value": "", "type": "query", "description": "The ID of the partner." }, { "name": "requestorId", "value": "", "type": "query", "description": "The unique identifier (OCID) of the requestor in which to list resources." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return." }, { "name": "page", "value": "", "type": "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." }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either 'ASC' or 'DESC'." }, { "name": "sortBy", "value": "", "type": "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" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Exports a list of AccessRequestSummary objects within a compartment and during a specified time range in text format. You can filter the results by problem severity.\n" }, { "info": { "name": "Retrieves an access request.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220126/accessRequests/:accessRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "accessRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the access request." } ] }, "docs": "Retrieves an access request identified by the access request ID." }, { "info": { "name": "Retrieves the associated access details.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220126/accessRequests/:accessRequestId/accessMaterials", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "accessRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the access request." } ] }, "docs": "Retrieves the access credential/material associated with the access request.\n" }, { "info": { "name": "Handle the AccessRequest identified by the id", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220126/accessRequests/:accessRequestId/actions/handle", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "accessRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the access request." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Handle the AccessRequest" }, { "info": { "name": "Remind the AccessRequest and resend notifications to pending approvers", "type": "http" }, "http": { "method": "POST", "url": "http://127.0.0.1/20220126/accessRequests/:accessRequestId/actions/remind", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "accessRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the access request." } ] }, "docs": "Remind the AccessRequest" }, { "info": { "name": "Retrieves an access request for internal use.", "type": "http" }, "http": { "method": "GET", "url": "http://127.0.0.1/20220126/accessRequests/:accessRequestId/internal", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "accessRequestId", "value": "", "type": "path", "description": "The unique identifier (OCID) of the access request." } ] }, "docs": "Retrieves an access request identified by the access request ID for internal use." } ] } ], "bundled": true }