Secrets

A Secret stores named, typed secret material for later use by features that reference the Secret by ID.

Secret values are encrypted at rest and are write-only. API responses include metadata and configured value field names, but never include the stored secret values.

List Secrets

SDK Method

\Files\Model\Secret::list;

Return Object

Secret[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

try {
  $secrets = \Files\Model\Secret::list();
  foreach ($secrets as $secret) {
    // Operate on $secret
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Show Secret

SDK Method

\Files\Model\Secret::find;

Return Object

Secret

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		Secret ID.

Example Request

try {
  $secret = \Files\Model\Secret::find($id);
  // Operate on $secret
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Create Secret

SDK Method

\Files\Model\Secret::create;

Return Object

Secret

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDefaultDescription
name
string
Required		Secret name.
description
string		Internal description for your reference.
secret_type
string
Required		Secret type.
Possible values: basic, token, headers, certificate, key_value
metadata
object		Non-secret metadata for the Secret type.
workspace_id
int64		0Workspace ID. 0 means the default workspace.

Example Request

try {
  $secret = \Files\Model\Secret::create([
    'name' => "Production API token",
    'secret_type' => "token"
  ]);
  // Operate on $secret
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Update Secret

SDK Method

$secret->update;

Return Object

Secret

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
name
string		Secret name.
description
string		Internal description for your reference.
secret_type
string		Secret type.
Possible values: basic, token, headers, certificate, key_value
metadata
object		Non-secret metadata for the Secret type.

Example Request

try {
  // Find the secret object by its id.
  $secret = \Files\Model\Secret::find(id);
  $secret->update([
    'name' => "Production API token"
  ]);
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

Delete Secret

SDK Method

$secret->delete;

Return Object

No return value.

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Example Request

try {
  // Find the secret object by its id.
  $secret = \Files\Model\Secret::find(id);
  $secret->delete();
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The Secret Object

Some of the methods above return a Secret object. The attributes of this object are listed below.

AttributeDescription
id
int64		Secret ID.
workspace_id
int64		Workspace ID. 0 means the default workspace.
name
string		Secret name.
description
string		Internal description for your reference.
secret_type
string		Secret type.
Possible values: basic, token, headers, certificate, key_value
metadata
object		Non-secret metadata for the Secret type.
value_field_names
array(string)		Names of configured secret value fields. Secret values are never returned.
created_at
date-time		Secret create date/time.
updated_at
date-time		Secret update date/time.