Jump to

• Request
• Response

(Preview) Update credentials

put

/20260430/aiDataPlatforms/{aiDataPlatformId}/credentials/{credentialKey}

(Preview) Updates a credential object. The operation completes synchronously; callers can invoke get to confirm the latest state.

Request

Path Parameters

• aiDataPlatformId(required): string
  The [OCID](/iaas/Content/General/Concepts/identifiers.htm) of the AI Data Platform (Data Lake) instance.
• credentialKey(required): string
  The unique identifier of the credential object whose details are to be retrieved.

Header Parameters

• if-match: string
  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.
• opc-request-id: string
  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.
• should-update-recent: boolean
  A flag to identify if the recent list should be updated.

  Default Value: false

Body ()

The information to be updated.

Root Schema : UpdateDataLakeCredentialDetails

Type: object

The set of details required to update an existing credential object.

Show Source

• credentialDescription: string
  Minimum Length: 1

  Maximum Length: 255

  A brief summary of the credential object and its purpose.
• credentialDetails: object CredentialDetails
  Discriminator: credentialType

  The base object containing credential information, extended by specific credential types such as SecretTokenCredentialDetails or VaultReferenceCredentialDetails. The type of credential is identified by the `credentialType` property.
• displayName: string
  Minimum Length: 1

  Maximum Length: 255

  Pattern: ^[A-Za-z][A-Za-z0-9_]{0,254}$

  A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.
• type: string
  Allowed Values: [ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ]

  The type of credential stored. Allowed values are defined in CredentialType.

{
    "description":"The set of details required to update an existing credential object.",
    "type":"object",
    "properties":{
        "displayName":{
            "description":"A user-friendly name for the credential object. This value does not have to be unique and can be changed. Must start with a letter and contain only letters, numbers, or underscores. Avoid entering confidential information.",
            "type":"string",
            "minLength":1,
            "maxLength":255,
            "pattern":"^[A-Za-z][A-Za-z0-9_]{0,254}$"
        },
        "credentialDescription":{
            "description":"A brief summary of the credential object and its purpose.",
            "type":"string",
            "minLength":1,
            "maxLength":255
        },
        "type":{
            "description":"The type of credential stored. Allowed values are defined in CredentialType.",
            "type":"string",
            "x-obmcs-top-level-enum":"#/definitions/CredentialType",
            "enum":[
                "SECRET_TOKEN",
                "VAULT_REFERENCE",
                "SERVICE_ACCOUNT"
            ]
        },
        "credentialDetails":{
            "$ref":"#/definitions/CredentialDetails"
        }
    }
}

Nested Schema : CredentialDetails

Type: object

Discriminator: credentialType

The base object containing credential information, extended by specific credential types such as SecretTokenCredentialDetails or VaultReferenceCredentialDetails. The type of credential is identified by the `credentialType` property.

Show Source

• credentialType(required): string
  Allowed Values: [ "SECRET_TOKEN", "VAULT_REFERENCE", "SERVICE_ACCOUNT" ]

  Specifies the type of credential. Allowed values are defined in CredentialType.

{
    "description":"The base object containing credential information, extended by specific credential types \nsuch as SecretTokenCredentialDetails or VaultReferenceCredentialDetails. The type of credential\nis identified by the `credentialType` property.\n",
    "discriminator":"credentialType",
    "x-obmcs-discriminator-mapping":{
        "SECRET_TOKEN":"#/definitions/SecretTokenCredentialDetails",
        "SERVICE_ACCOUNT":"#/definitions/ServiceAccountCredentialDetails",
        "VAULT_REFERENCE":"#/definitions/VaultReferenceCredentialDetails"
    },
    "required":[
        "credentialType"
    ],
    "properties":{
        "credentialType":{
            "type":"string",
            "description":"Specifies the type of credential. Allowed values are defined in CredentialType.",
            "x-obmcs-top-level-enum":"#/definitions/CredentialType",
            "enum":[
                "SECRET_TOKEN",
                "VAULT_REFERENCE",
                "SERVICE_ACCOUNT"
            ]
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation. Credentials are updated.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

400 Response

Bad Request (invalid query parameters, malformed headers, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

401 Response

Unauthorized (missing or expired credentials, and so on).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

404 Response

Not Found. The requested resource was not found.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

405 Response

Method Not Allowed. Request is recognized but not supported.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

412 Response

Precondition Failed (One or more conditions in request failed).

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

429 Response

Too Many Requests. Too many requests sent to the server in a short period.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

500 Response

Internal Server Error. The server encountered an unexpected condition preventing fulfilment of the request.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

Default Response

Unknown Error. Error is not recognized by the system.

Headers

• opc-request-id: string
  Unique Oracle-assigned ID for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Body ()

Root Schema : Error

Type: object

Error information.

Show Source

• code(required): string
  A short error code that defines the error, meant for programmatic parsing.
• message(required): string
  A human-readable error message.

{
    "description":"Error information.",
    "required":[
        "code",
        "message"
    ],
    "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"
        }
    }
}

Back to Top