{ "opencollection": "1.0.0", "info": { "name": "Security Attribute API", "version": "20240815" }, "items": [ { "info": { "name": "securityAttribute", "type": "folder" }, "items": [ { "info": { "name": "ListSecurityAttributeNamespaces", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "sortOrder", "value": "", "type": "query", "description": "The sort order to use, either ascending (`ASC`) or descending (`DESC`)." }, { "name": "sortBy", "value": "", "type": "query", "description": "The field to sort by. You can provide one sort order (`sortOrder`). Default order for\nTIMECREATED is descending. Default order for NAME is ascending. The NAME\nsort order is case sensitive.\n\n**Note:** In general, some \"List\" operations (for example, `ListInstances`) let you\noptionally filter by Availability Domain if the scope of the resource type is within a\nsingle Availability Domain. If you call one of these \"List\" operations without specifying\nan Availability Domain, the resources are grouped by Availability Domain, then sorted.\n" }, { "name": "name", "value": "", "type": "query", "description": "A filter to return only resources that match the entire display name given." }, { "name": "compartmentIdInSubtree", "value": "", "type": "query", "description": "An optional boolean parameter indicating whether to retrieve all security attribute namespaces in subcompartments. If this\nparameter is not specified, only the namespaces defined in the specified compartment are retrieved.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the security attribute namespaces in the specified compartment.\n" }, { "info": { "name": "CreateSecurityAttributeNamespace", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "opc-request-id", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new security attribute namespace in the specified compartment.\n\nYou must specify the compartment ID in the request object (remember that the tenancy is simply the root\ncompartment).\n\nYou must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy\nand cannot be changed. The only valid characters for security attribute names are:  0-9, A-Z, a-z, -, _ characters.\nNames are case insensitive. That means, for example, \"myNamespace\" and \"mynamespac" }, { "info": { "name": "GetSecurityAttributeNamespace", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" } ] }, "docs": "Gets the specified security attribute namespace's information.\n" }, { "info": { "name": "UpdateSecurityAttributeNamespace", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified security attribute namespace. You can't update the namespace name.\n\nUpdating `isRetired` to 'true' retires the namespace and all the security attributes in the namespace. Reactivating a\nnamespace (changing `isRetired` from 'true' to 'false') does not reactivate security attributes.\nTo reactivate the security attributes, you must reactivate each one individually *after* you reactivate the namespace,\nusing [UpdateSecurityAttribute](#/en/security-attribute/latest/SecurityAttri" }, { "info": { "name": "DeleteSecurityAttributeNamespace", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" } ] }, "docs": "Deletes the specified security attribute namespace. Only an empty security attribute namespace can be deleted with this operation. To use this operation\nto delete a security attribute namespace that contains security attributes, first delete all of its security attributes.\nUse [DeleteSecurityAttribute](#/en/security-attribute/latest/SecurityAttribute/DeleteSecurityAttribute) to delete a security attribute.\n" }, { "info": { "name": "Deletes security attribute namespace that contains security attributes.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId/actions/cascadeDelete", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" } ] }, "docs": "Deletes the specified security attribute namespace. This operation triggers a process that removes all of the security attributes\ndefined in the specified security attribute namespace from all resources in your tenancy and then deletes the security attribute namespace.\n\nAfter you start the delete operation:\n\n * New security attribute key definitions cannot be created under the namespace.\n * The state of the security attribute namespace changes to DELETING.\n * Security attribute removal from t" }, { "info": { "name": "Changes compartment of a security attribute namespace.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId/actions/changeCompartment", "headers": [ { "name": "opc-retry-token", "value": "" }, { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Moves the specified security attribute namespace to the specified compartment within the same tenancy.\n\nTo move the security attribute namespace, you must have the manage security-attributes permission on both compartments.\nFor more information about IAM policies, see [Details for IAM](/Content/Identity/policyreference/iampolicyreference.htm).\n\nMoving a security attribute namespace moves all the security attributes contained in the security attribute namespace.\n" }, { "info": { "name": "ListSecurityAttributes", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId/securityAttributes", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "lifecycleState", "value": "", "type": "query", "description": "A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.\n" } ] }, "docs": "Lists the security attributes in the specified namespace.\n" }, { "info": { "name": "CreateSecurityAttribute", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId/securityAttributes", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new security attribute in the specified security attribute namespace.\n\nThe security attribute requires either the OCID or the name of the security attribute namespace that will contain this\nsecurity attribute.\n\nYou must specify a *name* for the attribute, which must be unique across all attributes in the security attribute namespace\nand cannot be changed. The only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters.\nNames are case insensitive. That means, " }, { "info": { "name": "GetSecurityAttribute", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId/securityAttributes/:securityAttributeName", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" }, { "name": "securityAttributeName", "value": "", "type": "path", "description": "The name of the security attribute.\n" } ] }, "docs": "Gets the specified security attribute's information." }, { "info": { "name": "UpdateSecurityAttribute", "type": "http" }, "http": { "method": "PUT", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId/securityAttributes/:securityAttributeName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" }, { "name": "securityAttributeName", "value": "", "type": "path", "description": "The name of the security attribute.\n" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the specified security attribute. You can only update `description`, and `isRetired`.\n" }, { "info": { "name": "DeleteSecurityAttribute", "type": "http" }, "http": { "method": "DELETE", "url": "https://127.0.0.1/20240815/securityAttributeNamespaces/:securityAttributeNamespaceId/securityAttributes/:securityAttributeName", "headers": [ { "name": "if-match", "value": "" }, { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "params": [ { "name": "securityAttributeNamespaceId", "value": "", "type": "path", "description": "The OCID of the security attribute namespace.\n" }, { "name": "securityAttributeName", "value": "", "type": "path", "description": "The name of the security attribute.\n" } ] }, "docs": "Deletes the specified security attribute. This operation triggers a process that removes the\nsecurity attribute from all resources in your tenancy.\n\nWhen you start the delete operation, the state of the security attribute changes to DELETING and security attribute removal\nfrom resources begins. This can take up to 48 hours depending on the number of resources that\nwere tagged as well as the regions in which those resources reside.\n\nWhen all attributes have been removed, the state changes to DELE" }, { "info": { "name": "ListSecurityAttributeWorkRequests", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeWorkRequests/", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "compartmentId", "value": "", "type": "query", "description": "The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" }, { "name": "resourceIdentifier", "value": "", "type": "query", "description": "The identifier of the resource the work request affects." } ] }, "docs": "Lists the security attribute work requests in compartment.\n" }, { "info": { "name": "GetSecurityAttributeWorkRequest", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeWorkRequests/:workRequestId", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." } ] }, "docs": "Gets details on a specified work request. The workRequestID is returned in the opc-work-request-id header\nfor any asynchronous operation in security attributes service.\n" }, { "info": { "name": "ListSecurityAttributeWorkRequestErrors", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeWorkRequests/:workRequestId/errors", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Gets the errors for a work request.\n" }, { "info": { "name": "ListSecurityAttributeWorkRequestLogs", "type": "http" }, "http": { "method": "GET", "url": "https://127.0.0.1/20240815/securityAttributeWorkRequests/:workRequestId/logs", "headers": [ { "name": "opc-request-id", "value": "" } ], "params": [ { "name": "workRequestId", "value": "", "type": "path", "description": "The OCID of the work request." }, { "name": "page", "value": "", "type": "query", "description": "The value of the `opc-next-page` response header from the previous \"List\" call.\n" }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of items to return in a paginated \"List\" call.\n" } ] }, "docs": "Gets the logs for a work request.\n" }, { "info": { "name": "Delete multiple security attributes at the same time.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20240815/securityAttributes/actions/bulkDelete", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes the specified security attribute definitions. This operation triggers a process that removes the\nsecurity attributes from all resources in your tenancy. The security attributes must be within the same security attribute namespace.\n \nThe following actions happen immediately:\n \nAfter you start this operation, the state of the tag changes to DELETING, and security attribute removal\nfrom resources begins. This process can take up to 48 hours depending on the number of resources that\nare ta" }, { "info": { "name": "Edit multiple security attributes on resources.", "type": "http" }, "http": { "method": "POST", "url": "https://127.0.0.1/20240815/securityAttributes/actions/bulkEdit", "headers": [ { "name": "opc-request-id", "value": "" }, { "name": "opc-retry-token", "value": "" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Edits the specified list of security attributes for the selected resources.\nThis operation triggers a process that edits the attributes on all selected resources. The possible actions are:\n\n * Add a security attribute when it does not already exist on the resource.\n * Update the value for a security attribute when it is present on the resource.\n * Add a security attribute when it does not already exist on the resource or update the value when it is present on the resource.\n * Remove a securi" } ] } ], "bundled": true }