Update Credential

Select

SaaS

Customer Managed

Edit credential whose id has been provided by credential owner

Path Parameters

• credentialId string required

application/json

Request Body

oneOf

• CredentialContent
• CloudCredentialContent
• CloudCredentialContentWithTokenId
• CloudCredentialContentWithAPIKey
• SalesforceCredentialContent
• AmazonCredentialContent
• AmazonCredentialContentWithRoleArn
• AzureCredentialContent
• AzureCredentialContentWithTenantId
• AzureCredentialContentWithCertificate
• GoogleCredentialContent
• GoogleServiceAccountCredentialContent
• OracleCredentialContent
• ServiceNowCredentialInfo

---

newName string

Updated name of credential

userAccount string required

User account of Credential. If updated the updated user account is considered else the existing user account is considered.

newPassword string required

Updated password of credential. The password has to be provided in Base64 format.

description string

Updated description of Credential

newName string

Updated name of credential

accessKeyId string required

Access Key ID of Credential. If updated the updated Access Key ID is considered else the existing Access Key ID is considered.

secretAccessKey string required

Secret Access Key of Credential and must be in base64 encoded format.

description string

Updated description of Credential

newName string

Updated name of credential

tokenId string required

Token ID of Credential. If updated the updated token Id is considered else the existing token Id is considered.

sharedSecret string required

Updated Shared secret of Credential and must be in base64 encoded format.

description string

Updated description of Credential

newName string

Updated name of credential

userAccount string required

User account of Credential. If updated the updated user account is considered else the existing user account is considered.

apiKey string required

Updated API Key of Credential and must be in base64 encoded format.

description string

Updated description of Credential

newName string

Updated name of credential

consumerKey string required

Consumer key of Credential

consumerSecret string required

Consumer secret of Credential

description string

Updated description of Credential

newName string

Updated name of credential

accessKeyId string required

Access Key ID of Credential. If updated the updated access key ID is considered.

secretAccessKey string required

Updated Secret Access Key of Credential and must be in base64 encoded format.

description string

Updated description of Credential

newName string

Updated name of credential

password string

roleArn string required

Role ARN of credential. If updated the updated role ARN is considered.

description string

Updated description of Credential

newName string

Updated name of credential

accountName string required

Account name of Credential. If updated the updated account name is considered else the existing account name is considered.

accessKeyId string required

Access key ID of Credential and must be in base64 encoded format.

description string

Updated description of Credential

authType string

Possible values: [AZUREACCOUNT]

Authentication type applicable only for Cloud Accounts with Microsoft Azure as vendor.

newName string

Updated name of credential

tenantId string required

Unique Azure active directory ID

applicationId string required

Unique Azure application ID

newApplicationSecret string required

Application secret of Credential and must be in base64 encoded format.

environment string required

Possible values: [AZURE_CLOUD, AZURE_USGOV, AZURE_GERMANCLOUD, AZURE_CHINACLOUD, AZURE_STACK]

Azure cloud deployed region

endpoints object required

Endpoints for Authentication, Storage and Management

activeDirectoryEndpoint string

storageEndpoint string

resourceManagerEndpoint string

description string

Updated description of Credential

authType string

Possible values: [AZUREACCOUNT]

Authentication type applicable only for Cloud Accounts with Microsoft Azure as vendor.

newName string

Updated name of credential

tenantId string required

Unique Azure active directory ID

applicationId string required

Unique Azure application ID

newApplicationSecret string required

Application secret of Credential and must be in base64 encoded format.

applicationCertificatePassword string required

Password of the certificate and must be in base64 encoded format.

certificate string required

Content of the certificate file. It should be base64 encoded. Accepted fileTypes are pfx, p12.

certificateThumbprint string required

Thumbprint of the certificate file.

environment string required

Possible values: [AZURE_CLOUD, AZURE_USGOV, AZURE_GERMANCLOUD, AZURE_CHINACLOUD, AZURE_STACK]

Azure cloud deployed region

endpoints object required

Endpoints for Authentication, Storage and Management

activeDirectoryEndpoint string

storageEndpoint string

resourceManagerEndpoint string

description string

Updated description of Credential

newName string

Updated name of credential

accessKeyId string required

Access key ID of Credential, applicable only if authType is Access Secret Key.

secretAccessKey string required

Secret Access Key of Credential and must be in base64 encoded format.

connectString string

Connect String for Credential

dbName string

DB Name for Credential

certificate string

Certificate of Credential

projectId string

Project ID of credential

description string

Updated description of Credential

newName string

Updated name of credential

userAccount string required

User Account of Credential

connectString string

Connect String for Credential

dbName string

DB Name for Credential

certificate string required

Certificate of Credential

projectId string required

Project ID of credential

description string

Updated description of Credential

newName string

Updated name of credential

userAccount string

User Account of Credential

password string required

Password of Credential. Password must be in base64 encoded format.

connectString string

Connect String for Credential

dbName string

DB Name for Credential

certificate string required

Certificate of Credential

tenancyOCID string required

Oracle Cloud ID

userOCID string required

User name for the Oracle Cloud ID

description string

Updated description of Credential

accountType CredentialAccountType required

Possible values: [WINDOWSACCOUNT, LINUXACCOUNT, STORAGE_ARRAY_ACCOUNT, CLOUD_ACCOUNT]

vendorType CloudVendorType

Possible values: [ALICLOUD_OSS, AMAZON_GLACIER, AMAZON, ATT_SYNAPTIC, REVERA_VAULT, CEPH_OBJECT_GATEWAY_S3, CMCC_ONEST, CLOUDIAN_HYPERSTORE, DELL_EMC_ECS_S3, EMC_ATMOS, FUJITSU_STORAGE_ETERNUS, GOOGLE_CLOUD, HDS_HCP, HITACHI_VANTARA_HCP_S3, HUAWEI_OSS, IBM_CLOUD, IBM_CLOUD_S3, INSPUR_CLOUD, IRON_MOUNTAIN_CLOUD, KINGSOFT_KS3, MICROSOFT_AZURE_TYPE, NETAPP_STORAGEGRID, NUTANIX_BUCKETS, OPENSTACK, AMPLIDATA, RACKSPACE_CLOUD_FILES, S3_COMPATIBLE, SALESFORCE_CONNECTED_APP, SCALITY_RING, TELEFONICA_OPEN_CLOUD_OBJECT_STORAGE, VERIZON_CLOUD, WASABI_HOT_CLOUD_STORAGE]

Cloud vendor types appilcable only for Cloud Account type

name string required

Name of Credential

authType string required

Possible values: [SERVICENOW_REST_API_KEY]

Authentication type.

authParamType string required

Possible values: [AUTH_HEADER, QUERY_PARAM]

Service Now Auth Param Type

authParamName string required

Service Now Auth param

restAPIKey string

Service Now REST API key

description string

Description of Credential

Responses

• 200
• 400
• 404

---

Success

application/json

• Schema
• Example (from schema)
• Example-1

---

Schema

• object

{}

{
  "name": "Credential1",
  "accountType": "LINUXACCOUNT",
  "userAccount": "xyz",
  "newPassword": "TmV3UGFzc3dvcmQ=",
  "description": "This is a description",
  "security": {
    "owner": {
      "user": {
        "id": 1
      }
    },
    "associations": [
      {
        "userGroup": {
          "id": 12
        },
        "permissions": {
          "permissionId": 218
        },
        "isCreatorAssociation": false
      },
      {
        "userGroup": {
          "id": 30
        },
        "permissions": {
          "permissionId": 218
        },
        "isCreatorAssociation": false
      }
    ]
  }
}

Bad Request

Not Found

PUT /v5/credential/:credentialid    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

credentialId — path required

Body

{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Credential/:credentialId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Credential/:credentialId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Credential/:credentialId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Credential/:credentialId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Credential/:credentialId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Credential/:credentialId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}'

curl -L -X PUT 'https://CommandCenterHostName/commandcenter/api/V5/Credential/:credentialId' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "newName": "string",
  "userAccount": "string",
  "newPassword": "string",
  "description": "string"
}'