openapi: 3.2.0 info: description: Use the OCI Cache API to create and manage clusters. A cluster is a memory-based storage solution. For more information, see [OCI Cache](/iaas/Content/ocicache/home.htm). title: OCI Cache Oci Cache User API version: '20220315' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/0c0709de34f2014ed9d1948ceeb3f59f7c24fee03209fa8269bdb6c37117b40d.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the OCI Cache 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/0c0709de34f2014ed9d1948ceeb3f59f7c24fee03209fa8269bdb6c37117b40d.yaml what: the harvested document for OCI Cache API servers: - url: http://127.0.0.1/20220315 - url: https://127.0.0.1/20220315 tags: - name: ociCacheUser paths: /ociCacheUsers: get: description: Lists the OCI Cache users based on the supplied parameters. operationId: ListOciCacheUsers parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/OciCacheUsernameQueryParam' - $ref: '#/components/parameters/LifeCycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The OCI cache user list is being retrieved. 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: $ref: '#/components/schemas/OciCacheUserCollection' 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: Gets a list of all OCI cache users based on the supplied parameters. tags: - ociCacheUser x-related-resource: '#/definitions/OciCacheUserSummary' post: description: Creates a new OCI Cache user. OCI Cache user is required to authenticate to OCI Cache cluster. operationId: CreateOciCacheUser parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted to create a new OCI cache user. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/OciCacheUser' 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: Creates a new OCI Cache User. tags: - ociCacheUser x-related-resource: '#/definitions/CreateOciCacheUserDetails' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateOciCacheUserDetails' description: Details required to create a new OCI cache user. required: true /ociCacheUsers/{ociCacheUserId}: delete: description: Deletes an existing OCI Cache User based on the OCI cache user unique ID (OCID). operationId: DeleteOciCacheUser parameters: - $ref: '#/components/parameters/OciCacheUserIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted for deleting the OCI cache user. 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete an existing OCI cache user based on the ID. tags: - ociCacheUser x-related-resource: '#/definitions/OciCacheUser' get: description: Get an existing OCI Cache users based on the ID (OCID). operationId: GetOciCacheUser parameters: - $ref: '#/components/parameters/OciCacheUserIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Successfully retrieved the OCI cache user. 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/OciCacheUser' 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: Get an existing OCI Cache User for the given ID (OCID). tags: - ociCacheUser put: description: Update an existing OCI Cache User with new details. operationId: UpdateOciCacheUser parameters: - $ref: '#/components/parameters/OciCacheUserIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted to update the OCI cache user. 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Update an existing OCI Cache User with supplied parameters. tags: - ociCacheUser x-related-resource: '#/definitions/OciCacheUser' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateOciCacheUserDetails' description: The information to be updated for an existing OCI Cache User. required: true /ociCacheUsers/{ociCacheUserId}/actions/changeCompartment: post: description: Moves an OCI Cache User from one compartment to another within the same tenancy. operationId: ChangeOciCacheUserCompartment parameters: - $ref: '#/components/parameters/OciCacheUserIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The request was accepted for moving the OCI cache user to a different compartment. 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: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' 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' summary: Moves an OCI cache user from one compartment to another compartment. tags: - ociCacheUser x-related-resource: '#/definitions/OciCacheUser' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeOciCacheUserCompartmentDetails' description: The configuration details to move compartment operation for an OCI cache user. required: true /ociCacheUsers/{ociCacheUserId}/actions/getRedisClusters: post: description: Gets a list of associated redis cluster for an OCI cache user. operationId: ListAttachedRedisClusters parameters: - $ref: '#/components/parameters/OciCacheUserIdentifierPathParam' - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page of AttachedOciCacheCluster to which the OciCacheUser is attached. 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/AttachedOciCacheCluster' 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: List associated redis cluster for an OCI cache user. tags: - ociCacheUser x-related-resource: '#/definitions/AttachedOciCacheCluster' components: parameters: PaginationTokenQueryParam: 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. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 SortByQueryParam: 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. ' in: query name: sortBy schema: type: string enum: - timeCreated - displayName default: timeCreated CompartmentIdQueryParam: description: The ID 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 LifeCycleStateQueryParam: description: A filter to return the resources, whose lifecycleState matches with the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/OciCacheUser/lifecycleState' schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 1000 minimum: 1 SortOrderQueryParam: description: The sort order to use, either 'ASC' or '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 OciCacheUsernameQueryParam: description: A filter to return the resources that match with the given OCI cache user name. in: query name: name x-default-description: 'null' schema: type: string maxLength: 255 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 executing 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 purged 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 OciCacheUserIdentifierPathParam: description: A filter to return only resources, that match with the given OCI cache user ID (OCID). in: path name: ociCacheUserId required: true schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string schemas: OciCacheUser: description: An OCI cache user is required to connect to an OCI cache cluster. properties: aclString: description: ACL string of OCI cache user. type: string authenticationMode: $ref: '#/components/schemas/AuthenticationMode' compartmentId: description: OCI Cache user compartment ID. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OCI cache user. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OCI Cache user unique ID. type: string lifecycleState: description: OCI Cache user lifecycle state. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string name: description: OCI Cache user name. type: string status: description: OCI Cache user status. ON enables and OFF disables the OCI cache user to login to the cluster. enum: - 'ON' - 'OFF' type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time, when the OCI cache user was created. format: date-time type: string timeUpdated: description: The date and time, when the OCI cache user was updated. format: date-time type: string required: - id - name - compartmentId - authenticationMode - aclString - status - lifecycleState type: object Error: description: Specifies details for an error. properties: code: description: A machine-usable code for the error that occured. type: string message: description: A human-readable error string for the error that occured. type: string required: - code - message AuthenticationMode: description: These are the Authentication details of an OCI cache user. discriminator: propertyName: authenticationType properties: authenticationType: description: This is Authentication Type of OCI cache user enum: - IAM - PASSWORD type: string required: - authenticationType OciCacheUserCollection: description: A list of OCI cache users that match filter criteria, if any. properties: items: description: A collection of OCI Cache users. items: $ref: '#/components/schemas/OciCacheUserSummary' type: array required: - items type: object UpdateOciCacheUserDetails: description: Details required to update an existing OCI cache user. properties: aclString: description: ACL string of OCI cache user. type: string authenticationMode: $ref: '#/components/schemas/AuthenticationMode' definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OCI cache user. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object status: description: OCI cache user status. ON enables and OFF disables the OCI cache user to login to the associated clusters. type: string x-obmcs-enumref: '#/definitions/OciCacheUser/status' type: object ChangeOciCacheUserCompartmentDetails: description: The configuration details for the move operation. properties: compartmentId: description: OCID of the compartment into which the OCI cache user will be moved. maxLength: 255 minLength: 1 type: string required: - compartmentId type: object AttachedOciCacheCluster: description: OciCacheCluster to which the OciCacheUser is attached. properties: ociCacheClusterId: description: 'OCID of the OciCacheCluster ' maxLength: 255 minLength: 1 type: string required: - ociCacheClusterId type: object CreateOciCacheUserDetails: description: Details required to create a new OCI cache user. properties: aclString: description: ACL string of OCI cache user. type: string authenticationMode: $ref: '#/components/schemas/AuthenticationMode' compartmentId: description: OCI cache user compartment ID. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OCI cache user. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object name: description: OCI cache user name is required to connect to an OCI cache cluster. maxLength: 255 minLength: 1 type: string status: description: OCI cache user status. ON enables and OFF disables the OCI cache user to login to the associated clusters. Default value is ON. type: string x-obmcs-enumref: '#/definitions/OciCacheUser/status' required: - name - description - compartmentId - authenticationMode - aclString type: object OciCacheUserSummary: description: OCI Cache user summary. properties: authenticationType: description: OCI Cache user authentication type. type: string x-obmcs-enumref: '#/definitions/AuthenticationMode/authenticationType' compartmentId: description: OCI Cache user compartment ID. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object description: description: Description of OCI cache user. type: string freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: OCI Cache user unique ID. type: string lifecycleState: description: OCI Cache user lifecycle state. type: string x-obmcs-enumref: '#/definitions/OciCacheUser/lifecycleState' name: description: OCI Cache user name. type: string status: description: OCI Cache user status. ON enables and OFF disables the OCI cache user to use the cluster. type: string x-obmcs-enumref: '#/definitions/OciCacheUser/status' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object timeCreated: description: The date and time, when the OCI cache user was created. format: date-time type: string required: - id - name - description - compartmentId - authenticationType - status - lifecycleState type: object 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 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. ' 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' 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 string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object securityAttributes: additionalProperties: additionalProperties: description: 'Attribute value and mode. Only the String type is supported for value. Mode is currently always "enforce". ' type: object description: 'Key-value pair representing a security attribute key and value, scoped to a namespace. Example: `{"MaxEgressCount": {"value": "42", "mode": "enforce"}}` ' type: object description: 'Security attributes for redis cluster resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Usage of system tag keys. These predefined keys are scoped to namespaces. Example: `{"orcl-cloud": {"free-tier-retained": "true"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.redisservice