OCI Signature Version 1

To support invoking of OCI REST APIs secured using an API Key, use the OCI_SIGNATURE_VERSION1 managed security policy.

Overview

To add the OCI Signature Version 1 policy to your document, use the available authentication scheme template. See Implement a New Connection Definition.

You can customize the security policy as needed for a connection definition.

Security Properties

A connection definition that uses this security policy defines the following properties in the securityProperties section. See Connection Properties and Sample Code.

The values in the name, displayName, shortDescription, and description columns list the default values that appear when you insert a security policy into an adapter definition document. You can update these values if needed.

name displayName shortDescription description Data type Required

TenancyOCID

Tenancy OCID

Tenancy OCID of OCI

Tenancy OCID of OCI

String

Yes

UserOCID

User OCID

User OCID of OCI

User OCID of OCI

String

Yes

PrivateKey

Private Key

OCI Private Key

OCI Private Key

URL_OR_FILE

Yes

FingerPrint

Finger Print

Finger Print

Finger Print

String

Yes

PassPhrase

Pass Phrase

Password entered at the time of generating the public/private key.

Password entered at the time of generating the public/private key.

Password

No

Sample Code: OCI Signature Version 1

The following sample code shows how to define the OCI Signature Versio 1 policy in a connection.

"securityPolicies": [
  {
    "type": "managed",
    "policy": "OCI_SIGNATURE_VERSION1",
    "description": "OCI Signature Version 1",
    "displayName": "OCI Signature Version 1",
    "scope": "ACTION",
    "securityProperties": [
      {
        "name": "TenancyOCID",
        "displayName": "Tenancy OCID",
        "description": "Tenancy OCID of OCI.",
        "shortDescription": "Example: ocid1.tenancy.oc1..mockId",
        "hidden": false,
        "required": true
      },
      {
        "name": "UserOCID",
        "displayName": "User OCID",
        "description": "User OCID of OCI.",
        "shortDescription": "Example: ocid1.user.oc1..mockUser",
        "hidden": false,
        "required": true
      },
      {
        "name": "PrivateKey",
        "displayName": "Private Key",
        "description": "OCI Private Key File.",
        "shortDescription": "Upload the private key file",
        "hidden": false,
        "required": true
      },
      {
        "name": "FingerPrint",
        "displayName": "Finger Print",
        "description": "Key Finger Print.",
        "shortDescription": "Example: 4c:8e:79:e3:a3:31:b3:8f:18:71:93:0c:c4:49:52:1c",
        "hidden": false,
        "required": true
      },
      {
        "name": "PassPhrase",
        "displayName": "Pass Phrase",
        "description": "Password entered at the time of generating the public/private key.",
        "shortDescription": "Password entered at the time of generating the public/private key.",
        "hidden": false,
        "required": true
      }
    ]
  }
]