Create a new integration credential

  • Published on Nov 20, 2025
  • 1 minute(s) read
Prev Next
Post
/sys/v1/credentials

Create a new integration credential

Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Body parameters
object
credential_details

Describes the authentication type for a given integration.

This type is the "backbone" to the credential objects in DSM as it's what contains the relevant information and references to the sobject(s) needed to authenticate to external systems/services.

OneOf
object
object
$type
string Required
Valid values[ "Oci" ]
body
OneOf
object
object
$type
string Required
Valid values[ "ApiKey" ]
user_ocid
string Required

The user's OCID from Oracle who will have the public key configured as an "API Key" on Oracle servers. That public key is part of the key-pair represented by signing_key.

tenant_ocid
string Required

The tenant OCID from Oracle

signing_key
string (uuid) Required

A wrapper type to provide better clarity of the id referenced is in fact to security object.

description
string | null
group_id
string (uuid) Required

The ID of the group that this credential is associated with

name
string Required

The human readable name of the credential

Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
Responses
2XX

Success result

object
created_at
string

The time the credential was created

Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
Example20170509T070912Z
creator

A security principal.

OneOf
PrincipalVariantApp
object (PrincipalVariantApp)
app
string (uuid)
PrincipalVariantUser
object (PrincipalVariantUser)
user
string (uuid)
PrincipalVariantPlugin
object (PrincipalVariantPlugin)
plugin
string (uuid)
PrincipalVariantUserViaApp
object (PrincipalVariantUserViaApp)
userviaapp
object
user_id
string (uuid)
scopes
Array of string (OauthScope)
string

OAuth scope.

Valid values[ "app", "openid", "email", "profile" ]
string
string
Valid values[ "system" ]
string
string
Valid values[ "unregistereduser" ]
credential_details

Describes the authentication type for a given integration.

This type is the "backbone" to the credential objects in DSM as it's what contains the relevant information and references to the sobject(s) needed to authenticate to external systems/services.

OneOf
object
object
$type
string
Valid values[ "Oci" ]
body
OneOf
object
object
$type
string
Valid values[ "ApiKey" ]
user_ocid
string

The user's OCID from Oracle who will have the public key configured as an "API Key" on Oracle servers. That public key is part of the key-pair represented by signing_key.

tenant_ocid
string

The tenant OCID from Oracle

signing_key
string (uuid)

A wrapper type to provide better clarity of the id referenced is in fact to security object.

credential_id
string (uuid)
description
string | null
group_id
string (uuid)

The ID of the group that this credential is associated with

name
string

The human readable name of the credential

Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$