Update Credential
Edit credential whose id has been provided by credential owner
Path Parameters
- credentialId string required
- application/json
Request Body
- CredentialContent
- CloudCredentialContent
- CloudCredentialContentWithTokenId
- CloudCredentialContentWithAPIKey
- SalesforceCredentialContent
- AmazonCredentialContent
- AmazonCredentialContentWithRoleArn
- AzureCredentialContent
- AzureCredentialContentWithTenantId
- GoogleCredentialContent
- GoogleServiceAccountCredentialContent
- OracleCredentialContent
- newName string
Updated name of credential
- userAccount string
User account of Credential. If updated the updated user account is considered else the existing user account is considered.
- newPassword string
Updated password of credential. The password has to be provided in Base64 format.
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- accessKeyId string
Access Key ID of Credential. If updated the updated Access Key ID is considered else the existing Access Key ID is considered.
- newSecretAccessKey string
Secret Access Key of Credential and must be in base64 encoded format.
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- tokenId string
Token ID of Credential. If updated the updated token Id is considered else the existing token Id is considered.
- newSharedSecret string
Updated Shared secret of Credential and must be in base64 encoded format.
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- userAccount string
User account of Credential. If updated the updated user account is considered else the existing user account is considered.
- newApiKey string
Updated API Key of Credential and must be in base64 encoded format.
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- consumerKey string
Consumer key of Credential
- newConsumerSecret string
Consumer secret of Credential
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- accessKeyId string
Access Key ID of Credential. If updated the updated access key ID is considered.
- newSecretAccessKey string
Updated Secret Access Key of Credential and must be in base64 encoded format.
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- roleArn string
Role ARN of credential. If updated the updated role ARN is considered.
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- accountName string
Account name of Credential. If updated the updated account name is considered else the existing account name is considered.
- newAccessKeyId string
Access key ID of Credential and must be in base64 encoded format.
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- tenantId string
Unique Azure active directory ID
- applicationId string
Unique Azure application ID
- newApplicationSecret string
Application secret of Credential and must be in base64 encoded format.
- environment string
Possible values: [
AZURE_CLOUD
,AZURE_USGOV
,AZURE_GERMANCLOUD
,AZURE_CHINACLOUD
,AZURE_STACK
]Azure cloud deployed region
endpoints object
- description string
Updated description of Credential
security object
- newName string
Updated name of credential
- accessKeyId string
Access key ID of Credential, applicable only if authType is Access Secret Key.
- secretAccessKey string
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
security object
- newName string
Updated name of credential
- userAccount string
User Account of Credential
- 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
security object
- newName string
Updated name of credential
- userAccount string
User Account of Credential
- password string
Password of Credential. Password must be in base64 encoded format.
- connectString string
Connect String for Credential
- dbName string
DB Name for Credential
- certificate string
Certificate of Credential
- tenancyOCID string
Oracle Cloud ID
- userOCID string
User name for the Oracle Cloud ID
- description string
Updated description of Credential
security object
- 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
Request
curl -L -X PUT 'https://localhost/webconsole/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",
"security": {
"owner": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
}
},
"associations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"permissions": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
},
"isCreatorAssociation": true
}
]
}
}'
curl -L -X PUT 'https://localhost/webconsole/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",
"security": {
"owner": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
}
},
"associations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"permissions": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
},
"isCreatorAssociation": true
}
]
}
}'
curl -L -X PUT 'https://localhost/webconsole/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",
"security": {
"owner": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
}
},
"associations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"permissions": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
},
"isCreatorAssociation": true
}
]
}
}'
curl -L -X PUT 'https://localhost/webconsole/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",
"security": {
"owner": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
}
},
"associations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"permissions": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
},
"isCreatorAssociation": true
}
]
}
}'
curl -L -X PUT 'https://localhost/webconsole/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",
"security": {
"owner": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
}
},
"associations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"permissions": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
},
"isCreatorAssociation": true
}
]
}
}'
curl -L -X PUT 'https://localhost/webconsole/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",
"security": {
"owner": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
}
},
"associations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"permissions": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
},
"isCreatorAssociation": true
}
]
}
}'
curl -L -X PUT 'https://localhost/webconsole/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",
"security": {
"owner": {
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
}
},
"associations": [
{
"user": {
"id": 0,
"name": "string"
},
"userGroup": {
"id": 0,
"name": "string"
},
"permissions": {
"permissionId": 0,
"permissionName": "string",
"categoryId": 0,
"categoryName": "string",
"type": "ALL_CATEGORIES",
"exclude": true
},
"isCreatorAssociation": true
}
]
}
}'