curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/secret-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "secret-group",
"name": "<string>",
"integration_fqn": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"ownedBy": {
"account": "<string>"
}
}
}
'{
"data": {
"name": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"associatedSecrets": [
{
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"secretGroupId": "<string>",
"value": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"secretVersions": [
{
"id": "<string>",
"fqn": "<string>",
"value": "<string>",
"version": 123,
"secret": "<unknown>",
"secretId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"activeDeploymentsCount": 123,
"createdBy": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"fqn": "<string>",
"integrationId": "<string>",
"manifest": {},
"accountId": "<string>",
"createdBy": "<string>"
}
}Creates a new secret group or updates an existing one based on the provided manifest.
curl --request PUT \
--url https://{controlPlaneURL}/api/svc/v1/secret-groups \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"manifest": {
"type": "secret-group",
"name": "<string>",
"integration_fqn": "<string>",
"collaborators": [
{
"subject": "<string>",
"role_id": "<string>"
}
],
"ownedBy": {
"account": "<string>"
}
}
}
'{
"data": {
"name": "<string>",
"tenantName": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"associatedSecrets": [
{
"id": "<string>",
"fqn": "<string>",
"name": "<string>",
"secretGroupId": "<string>",
"value": "<string>",
"createdBySubject": {
"subjectId": "<string>",
"subjectType": "user",
"subjectSlug": "<string>",
"subjectDisplayName": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"secretVersions": [
{
"id": "<string>",
"fqn": "<string>",
"value": "<string>",
"version": 123,
"secret": "<unknown>",
"secretId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"activeDeploymentsCount": 123,
"createdBy": "<string>"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"fqn": "<string>",
"integrationId": "<string>",
"manifest": {},
"accountId": "<string>",
"createdBy": "<string>"
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Secret Group Manifest
Show child attributes
+value=secret-group
secret-group +label=Name +usage=Name of the secret group +message=Enter a name with 5 to 50 characters. It can include letters, numbers, and hyphens. Must not start with a digit. Hyphens can only be in between and not at the start or end. Must not have consecutive hyphens. +sort=10000
+label=Secret Store +usage=Secret Store to be associated with the secret group +sort=10001
+label=Collaborators +sort=10002 +usage=Users and Teams that have access to Secret Group +uiType=Collaborators
+label=Owner +usage=Names of the owners that own this resource
Show child attributes
+label=Account Name +sort=1 +usage=The name of the account that owns this resource +placeholder=Search Account +uiType=AccountSelect +uiProps={"maxAllowedAccounts": 1}
Secret group created or updated successfully.
Secret Group
Show child attributes
Show child attributes
Subject ID
Subject type
user, team, serviceaccount, virtualaccount, external-identity Subject slug
Subject display name
Show child attributes
Show child attributes
Subject ID
Subject type
user, team, serviceaccount, virtualaccount, external-identity Subject slug
Subject display name
Show child attributes
Was this page helpful?