openapi: 3.2.0 info: description: Use the Security Attributes API to manage security attributes and security attribute namespaces. For more information, see the documentation for [Security Attributes](/iaas/Content/zero-trust-packet-routing/managing-security-attributes.htm) and [Security Attribute Namespaces](/iaas/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). title: Security Attribute API version: '20240815' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/3e8451b0041723ae9290c072077d35981f7787ea31c714a04953c8ad404fbfac.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Security Attribute API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/3e8451b0041723ae9290c072077d35981f7787ea31c714a04953c8ad404fbfac.yaml what: the harvested document for Security Attribute API servers: - url: https://127.0.0.1/20240815 tags: - name: securityAttribute paths: /securityAttributeNamespaces: get: description: 'Lists the security attribute namespaces in the specified compartment. ' operationId: ListSecurityAttributeNamespaces parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/ShouldIncludeSubcompartments' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/SecurityAttributeNamespace/lifecycleState' schema: type: string responses: 200: description: The list is being retrieved. headers: opc-next-page: description: 'For pagination of a list of namespaces. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SecurityAttributeNamespaceSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListSecurityAttributeNamespaces tags: - securityAttribute post: description: 'Creates a new security attribute namespace in the specified compartment. You must specify the compartment ID in the request object (remember that the tenancy is simply the root compartment). You must also specify a *name* for the namespace, which must be unique across all namespaces in your tenancy and cannot be changed. The only valid characters for security attribute names are:  0-9, A-Z, a-z, -, _ characters. Names are case insensitive. That means, for example, "myNamespace" and "mynamespace" are not allowed in the same tenancy. Once you created a namespace, you cannot change the name. If you specify a name that''s already in use in the tenancy, a 409 error is returned. You must also specify a *description* for the namespace. It does not have to be unique, and you can change it with [UpdateSecurityAttributeNamespace](#/en/security-attribute/latest/SecurityAttributeNamespace/UpdateSecurityAttributeNamespace). ' operationId: CreateSecurityAttributeNamespace parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The security attribute namespace is being created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityAttributeNamespace' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CreateSecurityAttributeNamespace tags: - securityAttribute x-example: "POST /20160918/securityAttributeNamespaces/\nHost: identity.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"compartmentId\" : \"ocid1.tenancy.oc1..aaaaaaaabaexampleuniqueID\",\n \"name\" : \"example-security-attribute-namespace\",\n \"description\" : \"This is the Zero Trust Packet Routing security attribute namespace.\",\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityAttributeNamespaceDetails' description: Request object for creating a new security attribute namespace. required: true /securityAttributeNamespaces/{securityAttributeNamespaceId}: delete: description: 'Deletes the specified security attribute namespace. Only an empty security attribute namespace can be deleted with this operation. To use this operation to delete a security attribute namespace that contains security attributes, first delete all of its security attributes. Use [DeleteSecurityAttribute](#/en/security-attribute/latest/SecurityAttribute/DeleteSecurityAttribute) to delete a security attribute. ' operationId: DeleteSecurityAttributeNamespace parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The security attribute namespace has successfully been deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteSecurityAttributeNamespace tags: - securityAttribute x-example: 'DELETE /20160918/securityAttributeNamespaces/<securityAttributeNamespace_OCID> Host: identity.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-related-resource: '#/definitions/SecurityAttributeNamespace' get: description: 'Gets the specified security attribute namespace''s information. ' operationId: GetSecurityAttributeNamespace parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The security attribute namespace was retrieved. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityAttributeNamespace' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetSecurityAttributeNamespace tags: - securityAttribute put: description: 'Updates the specified security attribute namespace. You can''t update the namespace name. Updating `isRetired` to ''true'' retires the namespace and all the security attributes in the namespace. Reactivating a namespace (changing `isRetired` from ''true'' to ''false'') does not reactivate security attributes. To reactivate the security attributes, you must reactivate each one individually *after* you reactivate the namespace, using [UpdateSecurityAttribute](#/en/security-attribute/latest/SecurityAttribute/UpdateSecurityAttribute). For more information about retiring security attribute namespaces, see [Managing Security Attribute Namespaces](/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). You can''t add a namespace with the same name as a retired namespace in the same tenancy. ' operationId: UpdateSecurityAttributeNamespace parameters: - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The security attribute namespace was updated. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityAttributeNamespace' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateSecurityAttributeNamespace tags: - securityAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityAttributeNamespaceDetails' description: Request object for updating a namespace. required: true /securityAttributeNamespaces/{securityAttributeNamespaceId}/actions/cascadeDelete: post: description: "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 the resources begins.\n\nThis process can take up to 48 hours depending on the number of security attributes in the namespace, the number of resources\nthat are tagged, and the locations of the regions in which those resources reside.\n\nAfter all security attributes are removed, the state changes to DELETED. You cannot restore a deleted security attribute namespace. After the deleted security attribute namespace\nchanges its state to DELETED, you can use the name of the deleted security attribute namespace again.\n\nAfter you start this operation, you cannot start either the [DeleteSecurityAttribute](#/en/security-attribute/latest/SecurityAttribute/DeleteSecurityAttribute) or the [BulkDeleteSecurityAttributes](#/en/security-attribute/latest/SecurityAttribute/BulkDeleteSecurityAttributes) operation until this process completes.\n\nTo delete a security attribute namespace, you must first retire it. Use [UpdateSecurityAttributeNamespace](#/en/security-attribute/latest/SecurityAttributeNamespace/UpdateSecurityAttributeNamespace)\nto retire a security attribute namespace.\n" operationId: CascadingDeleteSecurityAttributeNamespace parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes security attribute namespace that contains security attributes. tags: - securityAttribute x-example: 'POST /securityAttributeNamespaces/<securityAttributeNamespace_OCID>/actions/cascadeDelete/ Host: identity.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-get-work-request-operation: GetSecurityAttributeWorkRequest x-related-resource: '#/definitions/SecurityAttributeNamespace' /securityAttributeNamespaces/{securityAttributeNamespaceId}/actions/changeCompartment: post: description: 'Moves the specified security attribute namespace to the specified compartment within the same tenancy. To move the security attribute namespace, you must have the manage security-attributes permission on both compartments. For more information about IAM policies, see [Details for IAM](/Content/Identity/policyreference/iampolicyreference.htm). Moving a security attribute namespace moves all the security attributes contained in the security attribute namespace. ' operationId: ChangeSecurityAttributeNamespaceCompartment parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The compartment of the security attribute namespace was changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Changes compartment of a security attribute namespace. tags: - securityAttribute x-related-resource: '#/definitions/SecurityAttributeNamespace' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeSecurityAttributeNamespaceCompartmentDetails' description: Request object for changing the compartment of a security attribute namespace. required: true /securityAttributeNamespaces/{securityAttributeNamespaceId}/securityAttributes: get: description: 'Lists the security attributes in the specified namespace. ' operationId: ListSecurityAttributes parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: 'A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. ' in: query name: lifecycleState required: false x-obmcs-enumref: '#/definitions/SecurityAttribute/lifecycleState' schema: type: string responses: 200: description: The list of security attributes being retrieved. headers: opc-next-page: description: 'For pagination of a list of security attributes. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SecurityAttributeSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListSecurityAttributes tags: - securityAttribute post: description: 'Creates a new security attribute in the specified security attribute namespace. The security attribute requires either the OCID or the name of the security attribute namespace that will contain this security attribute. You must specify a *name* for the attribute, which must be unique across all attributes in the security attribute namespace and cannot be changed. The only valid characters for security attribute names are: 0-9, A-Z, a-z, -, _ characters. Names are case insensitive. That means, for example, "mySecurityAttribute" and "mysecurityattribute" are not allowed in the same namespace. If you specify a name that''s already in use in the security attribute namespace, a 409 error is returned. The security attribute must have a *description*. It does not have to be unique, and you can change it with [UpdateSecurityAttribute](#/en/security-attribute/latest/SecurityAttribute/UpdateSecurityAttribute). The security attribute must have a value type, which is specified with a validator. Security attribute can use either a static value or a list of possible values. Static values are entered by a user applying the security attribute to a resource. Lists are created by the user and the user must apply a value from the list. Lists are validated. ' operationId: CreateSecurityAttribute parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The security attribute has been created. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityAttribute' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: CreateSecurityAttribute tags: - securityAttribute x-example: "POST /20160918/securityAttributeNamespaces/ocid1.sanamepace.oc1..aaaaaaaabaexampleuniqueID/securityAttributes\nHost: identity.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"name\" : \"Administrator\",\n \"description\" : \"This security attribute will be used for billing of associated resources.\",\n \"type\" : \"string\"\n}\n" requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateSecurityAttributeDetails' description: Request object for creating a new security attribute in the specified security attribute namespace. required: true /securityAttributeNamespaces/{securityAttributeNamespaceId}/securityAttributes/{securityAttributeName}: delete: description: 'Deletes the specified security attribute. This operation triggers a process that removes the security attribute from all resources in your tenancy. When you start the delete operation, the state of the security attribute changes to DELETING and security attribute removal from resources begins. This can take up to 48 hours depending on the number of resources that were tagged as well as the regions in which those resources reside. When all attributes have been removed, the state changes to DELETED. You cannot restore a deleted attribute. Once the deleted attribute changes its state to DELETED, you can use the same security attribute name again. After you start this operation, you cannot start either the [BulkDeleteSecurityAttributes](#/en/security-attribute/latest/SecurityAttribute/BulkDeleteSecurityAttributes) or the [CascadeDeleteSecurityAttributeNamespace](#/en/security-attribute/latest/SecurityAttributeNamespace/CascadingDeleteSecurityAttributeNamespace) operation until this process completes. To delete a security attribute, you must first retire it. Use [UpdateSecurityAttribute](#/en/security-attribute/latest/SecurityAttribute/UpdateSecurityAttribute) to retire a security attribute. ' operationId: DeleteSecurityAttribute parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/SecurityAttributeNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 403: $ref: '#/components/responses/403' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: DeleteSecurityAttribute tags: - securityAttribute x-example: 'DELETE /20160918/securityAttributeNamespaces/<securityAttributeNamespace_OCID>/securityAttributes/<securityAttributeName> Host: identity.us-phoenix-1.oraclecloud.com <authorization and other headers> ' x-obmcs-get-work-request-operation: GetSecurityAttributeWorkRequest x-related-resource: '#/definitions/SecurityAttribute' get: description: Gets the specified security attribute's information. operationId: GetSecurityAttribute parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/SecurityAttributeNamePathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The security attribute was retrieved. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityAttribute' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetSecurityAttribute tags: - securityAttribute put: description: 'Updates the specified security attribute. You can only update `description`, and `isRetired`. ' operationId: UpdateSecurityAttribute parameters: - $ref: '#/components/parameters/SecurityAttributeNamespaceIdPathParam' - $ref: '#/components/parameters/SecurityAttributeNamePathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The security attribute was updated. headers: etag: description: For optimistic concurrency control. See `if-match`. schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/SecurityAttribute' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: UpdateSecurityAttribute tags: - securityAttribute requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateSecurityAttributeDetails' description: Request object for updating a security attribute. required: true /securityAttributeWorkRequests/: get: description: 'Lists the security attribute work requests in compartment. ' operationId: ListSecurityAttributeWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/ResourceIdentifierQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A list of security attribute work requests. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: items: $ref: '#/components/schemas/SecurityAttributeWorkRequestSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListSecurityAttributeWorkRequests tags: - securityAttribute /securityAttributeWorkRequests/{workRequestId}: get: description: 'Gets details on a specified work request. The workRequestID is returned in the opc-work-request-id header for any asynchronous operation in security attributes service. ' operationId: GetSecurityAttributeWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The work request was retrieved. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: 'The number of seconds that the client should wait before polling again. ' schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/SecurityAttributeWorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: GetSecurityAttributeWorkRequest tags: - securityAttribute /securityAttributeWorkRequests/{workRequestId}/errors: get: description: 'Gets the errors for a work request. ' operationId: ListSecurityAttributeWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of work request errors. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: 'The number of seconds that the client should wait before polling again. ' schema: type: number format: float content: application/json: schema: items: $ref: '#/components/schemas/SecurityAttributeWorkRequestErrorSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListSecurityAttributeWorkRequestErrors tags: - securityAttribute /securityAttributeWorkRequests/{workRequestId}/logs: get: description: 'Gets the logs for a work request. ' operationId: ListSecurityAttributeWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The list of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: 'The number of seconds that the client should wait before polling again. ' schema: type: number format: float content: application/json: schema: items: $ref: '#/components/schemas/SecurityAttributeWorkRequestLogSummary' type: array 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: ListSecurityAttributeWorkRequestLogs tags: - securityAttribute /securityAttributes/actions/bulkDelete: post: description: "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 tagged and the regions in which those resources reside.\n \nWhen all security attributes have been removed, the state changes to DELETED. You cannot restore a deleted security attribute. After the security attribute state\nchanges to DELETED, you can use the same security attribute name again.\n \nAfter you start this operation, you cannot start either the [DeleteSecurityAttribute](#/en/security-attribute/latest/SecurityAttribute/DeleteSecurityAttribute) or the [CascadeDeleteSecurityAttributeNamespace](#/en/security-attribute/latest/SecurityAttributeNamespace/CascadingDeleteSecurityAttributeNamespace) operation until this process completes.\n \nIn order to delete security attribute, you must first retire the security attribute. Use [UpdateSecurityAttribute](#/en/security-attribute/latest/SecurityAttributeNamespace/UpdateSecurityAttributeNamespace)\nto retire a security attribute.\n" operationId: BulkDeleteSecurityAttributes parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete multiple security attributes at the same time. tags: - securityAttribute x-example: "POST /20160918/securityAttributes/actions/bulkDelete/\nHost: identity.us-phoenix-1.oraclecloud.com\n<authorization and other headers>\n{\n \"securityAttributeIds\": [\n \"ocid1.sadefinition.oc1..<unique_ID_1>\",\n \"ocid1.sadefinition.oc1..<unique_ID_2>\",\n \"ocid1.sadefinition.oc1..<unique_ID_3>\"\n ]\n}\n" x-obmcs-get-work-request-operation: GetSecurityAttributeWorkRequest x-related-resource: '#/definitions/SecurityAttribute' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkDeleteSecurityAttributesDetails' description: Request object for deleting security attributes in bulk. required: true /securityAttributes/actions/bulkEdit: post: description: "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 security attribute from a resource. The security attribute is removed from the resource regardless of the value.\n\nThe edits can include a combination of operations and attributes.\nHowever, multiple operations cannot apply to the same attribute in the same request.\n" operationId: BulkEditSecurityAttributes parameters: - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: The request was accepted for processing. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the work request. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Edit multiple security attributes on resources. tags: - securityAttribute x-obmcs-get-work-request-operation: GetSecurityAttributeWorkRequest x-related-resource: '#/definitions/SecurityAttribute' requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkEditSecurityAttributeDetails' description: The request object for bulk editing security attributes on resources in the compartment. components: schemas: SecurityAttributeWorkRequestErrorSummary: description: 'The error entity. ' properties: code: description: A machine-usable code for the error that occured. type: string message: description: A human-readable error string. type: string timestamp: description: 'Date and time the error happened, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - code - message SecurityAttributeSummary: description: 'A security attribute definition that belongs to a specific security attribute namespace. ' properties: compartmentId: description: The OCID of the compartment that contains the security attribute. maxLength: 100 minLength: 1 type: string description: description: The description you assign to the security attribute. maxLength: 400 minLength: 1 type: string id: description: The OCID of the security attribute. maxLength: 100 minLength: 1 type: string isRetired: description: 'Whether the security attribute is retired. See [Managing Security Attributes](/Content/zero-trust-packet-routing/managing-security-attributes.htm). ' type: boolean lifecycleState: description: The security attribute's current state. After creating a security attribute, make sure its `lifecycleState` is ACTIVE before using it. After retiring a security attribute, make sure its `lifecycleState` is INACTIVE before using it. If you delete a security attribute, you cannot delete another security attribute until the deleted security attribute's `lifecycleState` changes from DELETING to DELETED. type: string x-obmcs-enumref: '#/definitions/SecurityAttribute/lifecycleState' name: description: 'The name assigned to the security attribute during creation. This is the security attribute. The name must be unique within the security attribute namespace and cannot be changed. ' maxLength: 100 minLength: 1 type: string securityAttributeNamespaceId: description: The OCID of the namespace that contains the security attribute. maxLength: 100 minLength: 1 type: string securityAttributeNamespaceName: description: 'The name of the security attribute namespace that contains the security attribute. ' maxLength: 100 minLength: 1 type: string timeCreated: description: 'Date and time the security attribute was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: description: The data type of the security attribute. type: string Error: description: Error information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error message. type: string required: - code - message BulkDeleteSecurityAttributesDetails: description: Properties for deleting security attributes in bulk. properties: securityAttributeIds: description: The OCIDs of the security attributes to delete. items: type: string type: array uniqueItems: true required: - securityAttributeIds type: object SecurityAttributeNamespace: description: 'A managed container for security attributes. A security attribute namespace is unique in a tenancy. For more information, see [Managing Security Attributes Namespaces](/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment that contains the namespace. maxLength: 100 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description you assign to the security attribute namespace. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security attribute namespace. maxLength: 100 minLength: 1 type: string isRetired: description: 'Indicates whether the security attribute namespace is retired. See [Managing Security Attribute Namespaces](/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). ' type: boolean lifecycleState: description: The security attribute namespace's current state. After creating a security attribute namespace, make sure its `lifecycleState` is ACTIVE before using it. After retiring a security attribute namespace, make sure its `lifecycleState` is INACTIVE. enum: - ACTIVE - INACTIVE - DELETING - DELETED type: string mode: description: 'Indicates possible modes the security attributes in this namespace can be set to. This is not accepted from the user. Currently the supported values are enforce and audit. ' items: type: string type: array name: description: 'The name of the namespace. It must be unique across all namespaces in the tenancy and cannot be changed. ' maxLength: 100 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Date and time the security attribute namespace was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - compartmentId - name - description - isRetired - timeCreated BulkEditResource: properties: id: description: The unique OCID of the resource. type: string metadata: additionalProperties: description: Additional information that helps to identify the resource. type: string description: 'Additional information that identifies the resource for bulk editing of tags. This information is provided in the resource''s API documentation. ' example: "UPDATE API for bucket require 'namespaceName' and 'bucketName'.\nhttps://docs.cloud.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/Bucket/DeleteBucket\nhttps://docs.cloud.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/Bucket/UpdateBucket\n\nTo add a bucket for bulk actions, specify 'namespaceName' and 'bucketName' in\nthe metadata property:\n{\n \"identifier\": \"ocid_of_bucket\"\n \"entityType\": \"bucket\",\n \"metadata\":\n {\n \"namespaceName\": \"sampleNamespace\",\n \"bucketName\": \"sampleBucket\"\n }\n}\n" type: object resourceType: description: The type of resource. See [BulkEditResourceTypes](#/en/identity/latest/BulkEditTagsResourceTypeCollection/ListBulkEditTagsResourceTypes). type: string required: - id - resourceType type: object BulkEditSecurityAttributeDetails: properties: bulkEditOperations: description: 'The operations associated with the request to bulk edit tags. ' items: $ref: '#/components/schemas/BulkEditSecurityAttributeOperationDetails' type: array compartmentId: description: 'The OCID of the compartment where the bulk edit request is submitted. ' type: string resources: description: 'The resources to be updated. ' items: $ref: '#/components/schemas/BulkEditResource' type: array uniqueItems: true required: - compartmentId - resources - bulkEditOperations type: object BulkEditSecurityAttributeOperationDetails: properties: operationType: description: 'An enum-like description of the type of operation. * `ADD_WHERE_ABSENT` adds a security attribute only if it does not already exist on the resource. * `SET_WHERE_PRESENT` updates the value for a security attribute only if it is present on the resource. * `ADD_OR_SET` combines the first two operations to add a security attribute if it does not already exist on the resource or update the value if it is present on the resource. * `REMOVE` removes the security attribute from the resource. It''s removed from the resource regardless of the value. ' enum: - ADD_WHERE_ABSENT - SET_WHERE_PRESENT - ADD_OR_SET - REMOVE type: string securityAttributes: additionalProperties: additionalProperties: description: 'The value of the attribute. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: ``{"oracle-zpr": {"td": {"value": "42", "mode": "audit"}}}`` ' type: object required: - operationType - securityAttributes type: object SecurityAttributeWorkRequestLogSummary: description: 'The log entity. ' properties: message: description: A human-readable error string. type: string timestamp: description: 'Date and time the log was written, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - message BaseSecurityAttributeValidator: description: 'Validates a security attribute value. Each validator performs validation steps in addition to the standard validation for security attribute values. For more information, see [Limits on Security Attributes](/Content/zero-trust-packet-routing/overview.htm). If you define a validator after a value has been set for a security attribute, then any updates that attempt to change the value must pass the additional validation defined by the current rule. Previously set values (even those that would fail the current validation) are not updated. You can still update other attributes to resources that contain a non-valid security attribute. To clear the validator call UpdateSecurityAttribute with [DefaultSecuirtyAttributeValidator](/api/#/en/securityattribute/latest/datatypes/DefaultTagDefinitionValidator). ' discriminator: propertyName: validatorType properties: validatorType: description: 'Specifies the type of validation: a static value (no validation) or a list. ' enum: - ENUM - DEFAULT type: string required: - validatorType SecurityAttribute: description: 'A security attribute that belongs to a specific security attribute namespace. Security attributes must be created in a tenancy before a user can apply them to resources. For more information, see [Managing Security Attributes](/Content/zero-trust-packet-routing/managing-security-attributes.htm). **Warning:** Oracle recommends that you avoid using any confidential information when you supply string values using the API. ' properties: compartmentId: description: The OCID of the compartment that contains the security attribute definition. maxLength: 100 minLength: 1 type: string description: description: The description of the security attribute. maxLength: 400 minLength: 1 type: string id: description: The OCID of the security attribute definition. maxLength: 100 minLength: 1 type: string isRetired: description: 'Indicates whether the security attribute is retired. See [Managing Security Attribute Namespaces](/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). ' type: boolean lifecycleState: description: The security attribute's current state. After creating a security attribute, make sure its `lifecycleState` is ACTIVE before using it. After retiring a security attribute, make sure its `lifecycleState` is INACTIVE before using it. If you delete a security attribute, you cannot delete another security attribute until the deleted tag's `lifecycleState` changes from DELETING to DELETED. enum: - ACTIVE - INACTIVE - DELETING - DELETED type: string name: description: 'The name assigned to the security attribute during creation. This is the security attribute key. The name must be unique within the security attribute namespace and cannot be changed. ' maxLength: 100 minLength: 1 type: string securityAttributeNamespaceId: description: The OCID of the security attribute namespace that contains the security attribute definition. maxLength: 100 minLength: 1 type: string securityAttributeNamespaceName: description: 'The name of the security attribute namespace that contains the security attribute. ' maxLength: 100 minLength: 1 type: string timeCreated: description: 'Date and time the security attribute was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string type: description: The data type of the security attribute. type: string validator: $ref: '#/components/schemas/BaseSecurityAttributeValidator' required: - compartmentId - securityAttributeNamespaceId - securityAttributeNamespaceName - id - name - description - isRetired - timeCreated ChangeSecurityAttributeNamespaceCompartmentDetails: description: 'Details of the compartment the resource is being moved to. ' properties: compartmentId: description: The Oracle Cloud ID (OCID) of the destination compartment. maxLength: 255 minLength: 1 type: string required: - compartmentId WorkRequestResource: description: 'The resource entity. ' properties: actionType: description: The way in which this resource was affected by the work tracked by the work request. enum: - CREATED - UPDATED - DELETED - RELATED - IN_PROGRESS - FAILED type: string entityType: description: The resource type the work request is affects. type: string entityUri: description: The URI path that the user can do a GET on to access the resource metadata. type: string identifier: description: The resource identifier the work request affects. type: string required: - identifier - actionType - entityType UpdateSecurityAttributeDetails: description: 'Details of the security attribute to be updated for a specific security attribute namespace. ' properties: description: description: The description of the security attribute during creation. maxLength: 400 minLength: 1 type: string isRetired: description: 'Whether the security attribute is retired. See [Managing Security Attributes](/Content/zero-trust-packet-routing/managing-security-attributes.htm). ' type: boolean validator: $ref: '#/components/schemas/BaseSecurityAttributeValidator' CreateSecurityAttributeNamespaceDetails: description: 'Details of the security attribute namespace to be created for a specific compartment. ' properties: compartmentId: description: The OCID of the tenancy containing the security attribute namespace. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description you assign to the security attribute namespace during creation. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object name: description: 'The name you assign to the security attribute namespace during creation. The name must be unique across all namespaces in the tenancy and cannot be changed. ' maxLength: 100 minLength: 1 type: string required: - name - compartmentId - description SecurityAttributeNamespaceSummary: description: 'A container for security attributes. ' properties: compartmentId: description: The OCID of the compartment that contains the security attribute namespace. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: A description you create for the security attribute namespace to help you identify it. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: The OCID of the security attribute namespace. type: string isRetired: description: 'Indicates whether the security attribute namespace is retired. ' type: boolean lifecycleState: description: The security attribute namespace's current state. After creating a security attribute namespace, make sure its `lifecycleState` is ACTIVE before using it. After retiring a security attribute namespace, make sure its `lifecycleState` is INACTIVE. type: string x-obmcs-enumref: '#/definitions/SecurityAttributeNamespace/lifecycleState' mode: description: 'Indicates possible modes the security attributes in the namespace can be set to. This is not accepted from the user. Currently the supported values are enforce and audit. ' items: type: string type: array name: description: 'The name of the security attribute namespace. It must be unique across all security attribute namespaces in the tenancy and cannot be changed. ' maxLength: 100 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: 'Date and time the security attribute namespace was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string CreateSecurityAttributeDetails: description: 'Details of the security attribute to be created for a specific security attribute namespace. ' properties: description: description: The description you assign to the security attribute during creation. maxLength: 400 minLength: 1 type: string name: description: 'The name you assign to the security attribute during creation. This is the security attribute key. The name must be unique within the namespace and cannot be changed. ' maxLength: 100 minLength: 1 type: string validator: $ref: '#/components/schemas/BaseSecurityAttributeValidator' required: - name - description SecurityAttributeWorkRequest: description: 'The asynchronous API request does not take effect immediately. This request spawns an asynchronous workflow to fulfill the request. WorkRequest objects provide visibility for in-progress workflows. ' properties: compartmentId: description: The OCID of the compartment that contains the work request. type: string id: description: The OCID of the work request. type: string operationType: description: An enum-like description of the type of work the work request is doing. enum: - DELETE_SECURITY_ATTRIBUTE_DEFINITION - DELETE_NON_EMPTY_SECURITY_ATTRIBUTE_NAMESPACE - BULK_DELETE_SECURITY_ATTRIBUTES - BULK_EDIT_OF_SECURITY_ATTRIBUTES type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' percentComplete: description: 'How much progress the operation has made. ' format: float maximum: 100 minimum: 1 type: number resources: description: 'The resources this work request affects. ' items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - PARTIALLY_SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: 'Date and time the work was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'Date and time the work completed, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'Date and time the work started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - operationType - status UpdateSecurityAttributeNamespaceDetails: description: 'Details of the security attribute namespace to be updated. ' properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object description: description: The description you assign to the security attribute namespace to help you identify it. maxLength: 400 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object isRetired: description: 'Indicates whether the security attribute namespace is retired. See [Managing Security Attribute Namespaces](/Content/zero-trust-packet-routing/managing-security-attribute-namespaces.htm). ' type: boolean SecurityAttributeWorkRequestSummary: description: 'The work request summary. Tracks the status of the asynchronous operation. ' properties: compartmentId: description: The OCID of the compartment that contains the work request. type: string id: description: The OCID of the work request. type: string operationType: description: An enum-like description of the type of work the work request is doing. enum: - DELETE_SECURITY_ATTRIBUTE_DEFINITION - DELETE_NON_EMPTY_SECURITY_ATTRIBUTE_NAMESPACE - BULK_DELETE_SECURITY_ATTRIBUTES - BULK_EDIT_OF_SECURITY_ATTRIBUTES type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestOperationType' percentComplete: description: 'How much progress the operation has made. ' format: float maximum: 100 minimum: 1 type: number resources: description: 'The resources this work request affects. ' items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: The current status of the work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - PARTIALLY_SUCCEEDED - CANCELING - CANCELED type: string x-obmcs-top-level-enum: '#/definitions/WorkRequestStatus' timeAccepted: description: 'Date and time the work was accepted, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeFinished: description: 'Date and time the work completed, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string timeStarted: description: 'Date and time the work started, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` ' format: date-time type: string required: - id - operationType - status parameters: NameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PaginationTokenQueryParam: description: 'The value of the `opc-next-page` response header from the previous "List" call. ' in: query name: page schema: type: string maxLength: 512 minLength: 1 SortByQueryParam: description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. **Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted. ' in: query name: sortBy required: false x-default-description: 'null' schema: type: string enum: - TIMECREATED - NAME SecurityAttributeNamespaceIdPathParam: description: 'The OCID of the security attribute namespace. ' in: path name: securityAttributeNamespaceId required: true schema: type: string maxLength: 100 minLength: 1 ResourceIdentifierQueryParam: description: The identifier of the resource the work request affects. in: query name: resourceIdentifier required: false x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the compartment in which to list resources. in: query name: compartmentId x-default-description: 'null' schema: type: string IfMatchHeader: description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource''s current etag value. ' in: header name: if-match required: false schema: type: string PaginationLimitQueryParam: description: 'The maximum number of items to return in a paginated "List" call. ' in: query name: limit x-default-description: 'null' schema: type: integer maximum: 1000 minimum: 1 WorkRequestIdPathParam: description: The OCID of the work request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either ascending (`ASC`) or descending (`DESC`). in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is `DESC` when sorting by time and `ASC` otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrder' schema: type: string enum: - ASC - DESC SecurityAttributeNamePathParam: description: 'The name of the security attribute. ' in: path name: securityAttributeName required: true schema: type: string maxLength: 100 minLength: 1 RetryTokenHeader: description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of running that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and removed from the system, then a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 RequestIdHeader: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. The only valid characters for request IDs are letters, numbers, underscore, and dash. ' in: header name: opc-request-id schema: type: string ShouldIncludeSubcompartments: description: 'An optional boolean parameter indicating whether to retrieve all security attribute namespaces in subcompartments. If this parameter is not specified, only the namespaces defined in the specified compartment are retrieved. ' in: query name: compartmentIdInSubtree required: false x-default-description: false schema: type: boolean responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For list pagination. When this header appears in the response, additional pages of results remain. For important details about how pagination works, see [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine). ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a defined tag key and value, scoped to a namespace. Example: `{"CostCenter": "42"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only the String type is supported. ' type: object description: 'Key-value pair representing a system tag key and value, scoped to a namespace. Example: `{"free-tier-retained": "true"}` ' type: object description: 'System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.securityattribute