Update Credential
Select
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 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
security object
Update Security association of a list of users and user groups
owner object
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Update Security association of a list of users and user groups
owner object
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Update Security association of a list of users and user groups
owner object
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Update Security association of a list of users and user groups
owner object
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Update Security association of a list of users and user groups
owner object
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Update Security association of a list of users and user groups
owner object
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Update Security association of a list of users and user groups
owner object
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Security association of a list of users and user groups
owner object required
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- authType string
Possible values: [
AZUREACCOUNT]Aunthentication 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 Aunthentication, Storage and Management
activeDirectory stringstorage stringresourceManager string- description string
Updated description of Credential
security object
Security association of a list of users and user groups
owner object required
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Security association of a list of users and user groups
owner object required
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Security association of a list of users and user groups
owner object required
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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
security object
Security association of a list of users and user groups
owner object required
Owner of a credential can be a user or user group
user object
id int32name stringuserGroup object
id int32name stringassociations object[]
user object
id int32name stringuserGroup object
id int32name stringpermissions object
List of permissions associated with the entity. Either categoryId and categoryName or permissionId and permissionName will be returned. If categoryId or categoryName is returned, all the corresponding permissions in the category are associated with the entity.
permissionId int32permissionName stringcategoryId int32categoryName stringtype stringPossible values: [
ALL_CATEGORIES,CATEGORY_ENTITY,PERMISSION_ENTITY]Returns the type of association.
exclude booleanFlag to specify if this is included permission or excluded permission.
isCreatorAssociation booleanTo check if the user/user group associated is the owner.
- 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