Set Secret Key

Deprecated

This operation is deprecated. It still works. Use the successor operation of the Consumers API instead.

Every response of this operation carries a Deprecation: @1792368000 header and a Link header whose rel is successor-version:

Link: </apiops/projects/{projectName}/consumers>; rel="successor-version"

Endpoint

PUT /apiops/projects/{projectName}/credentials/{username}/secretKey/{secretKeyName}/

Authentication

Requires a Personal API Access Token.

Header

Authorization: Bearer YOUR_TOKEN

Request

Headers

Header	Value	Required
Authorization	Bearer {token}	Yes

Path Parameters

Parameter	Type	Required	Description
projectName	string	Yes	Project name
username	string	Yes	Username of the consumer
secretKeyName	string	Yes	Name of the secret key to assign

Notes

• Secret key must exist in the project or in the admin project
• Secret key must be of type SECRET_KEY
• Consumer must exist
• Only one secret key can be assigned to a consumer at a time
• Assigning a new secret key replaces the existing one if present

Response

Success Response (200 OK)

{
  "status": "SUCCESS",
  "deploymentResult": {
    "success": true,
    "message": "Deployment completed successfully",
    "environmentResults": [
      {
        "environmentName": "production",
        "success": true,
        "message": "Deployed successfully"
      },
      {
        "environmentName": "staging",
        "success": true,
        "message": "Deployed successfully"
      }
    ]
  }
}

Error Response (400 Bad Request)

{
  "status": "FAILURE",
  "resultMessage": "Credential (username: api-user) was not found!"
}

or

{
  "status": "FAILURE",
  "resultMessage": "Secret Key (name: my-secret-key) is not found!"
}

Error Response (401 Unauthorized)

{
  "status": "FAILURE",
  "resultMessage": "Token is not valid!"
}

cURL Example

curl -X PUT \
  "https://demo.apinizer.com/apiops/projects/MyProject/credentials/api-user/secretKey/my-secret-key/" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings

• Secret Key Requirements:

  • Secret key must exist in the project or admin project
  • Secret key must be of type SECRET_KEY
  • Secret key name is case-sensitive

• Consumer Requirements:

  • Consumer must exist
  • Consumer must be in the same project or accessible from the project

• Replacement Behavior:

  • Assigning a new secret key replaces any existing secret key
  • Previous secret key assignment is automatically removed

• Automatic Deployment:

  • Consumer is automatically deployed to all environments after secret key assignment
  • Deployment results are returned in the response

Permissions

• User must have IDENTITY + MANAGE permission in the project
• For automatic deployment, user must also have IDENTITY + DEPLOY_UNDEPLOY permission

Related Documentation

• Remove Secret Key - Remove secret key from consumer
• Set Certificate - Assign certificate to consumer
• List Credentials - List all consumers