Skip to content

Commit

Permalink
Merge pull request #521 from orkes-io/update_secret
Browse files Browse the repository at this point in the history
Update secret task
  • Loading branch information
RizaFarheen authored Sep 21, 2023
2 parents 94f4a0c + b3bcd6b commit dec96a3
Showing 1 changed file with 40 additions and 0 deletions.
40 changes: 40 additions & 0 deletions docs/reference-docs/operators/update-secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
sidebar_position: 14
---

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Update Secret

Update Secret is used to update value of any secret given the user has permission to update the secret.

## Definitions

```json
{
"name": "update_secret_task",
"taskReferenceName": "update_secret_task_ref",
"type": "UPDATE_SECRET",
"inputParameters": {
"_secrets": {
"secretKey" : "my_secret",
"secretValue" : "1234"
}
}
}
```

### Input Parameters

| Attributes | Description |
|-------------|-------------------------|
| secretKey | name of the secret key |
| secretValue | value of the secret key |

**Notes**
1. User must have update permission over the secretKey otherwise workflow will be terminated with 403 error.
2. If the secret does not exist by the secretKey, it will be created and the value will be as per the secretValue
3. Only one secret can be updated at a time.


0 comments on commit dec96a3

Please sign in to comment.