credentials

Creates, updates, deletes, gets or lists a credentials resource.

Overview

Name	credentials
Type	Resource
Id	linode.managed.credentials

Fields

The following fields are returned by SELECT queries:

get

The requested Managed Credential.

Name	Datatype	Description
id	integer	Read-only This Credential's unique ID.
label	string	The unique label for this Credential. This is for display purposes only. (example: prod-password-1, pattern: [a-zA-Z0-9-_ .]{2,75})
last_decrypted	string (date-time)	Read-only The date this Credential was last decrypted by a member of Linode special forces. (example: 2018-01-01T00:01:01)

list

A paginated list of ManagedCredentials.

Name	Datatype	Description
id	integer	Read-only This Credential's unique ID.
label	string	The unique label for this Credential. This is for display purposes only. (example: prod-password-1, pattern: [a-zA-Z0-9-_ .]{2,75})
last_decrypted	string (date-time)	Read-only The date this Credential was last decrypted by a member of Linode special forces. (example: 2018-01-01T00:01:01)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	credentialId		Returns a single Managed Credential. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
list	select		page, page_size	Returns a paginated list of managed credentials on your account. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
create	insert	label, password		Creates a managed credential to store usernames and passwords for applications running on your Linode. Akamai Support can use these credentials to access your applications when investigating or resolving issues. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
update	replace	credentialId		Updates the label of a Managed Credential. This operation does not update the username and password for a Managed Credential. To do this, run the Update a managed credential's username and password) operation instead. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
revoke	exec	credentialId		Deletes a managed credential. Akamai Support will no longer have access to this credential when investigating or resolving issues. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...
update_username_password	exec	credentialId, password		Updates the username and password for a managed credential. This operation can only be accessed by the unrestricted users of an account. Learn more... Learn more...

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
credentialId	string	The ID of the Credential to update.
page	integer	The page of a collection to return.
page_size	integer	The number of items to return per page.

SELECT examples

get

Returns a single Managed Credential.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

SELECT
id,
label,
last_decrypted
FROM linode.managed.credentials
WHERE credentialId = '{{ credentialId }}' -- required
;

list

Returns a paginated list of managed credentials on your account.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

SELECT
id,
label,
last_decrypted
FROM linode.managed.credentials
WHERE page = '{{ page }}'
AND page_size = '{{ page_size }}'
;

INSERT examples

create

Creates a managed credential to store usernames and passwords for applications running on your Linode. Akamai Support can use these credentials to access your applications when investigating or resolving issues.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

INSERT INTO linode.managed.credentials (
label,
password,
username
)
SELECT 
'{{ label }}' /* required */,
'{{ password }}' /* required */,
'{{ username }}'
RETURNING
id,
label,
last_decrypted
;

Manifest

# Description fields are for documentation purposes
- name: credentials
props:
  - name: label
    value: "{{ label }}"
    description: |
      The unique label for this Credential. This is for display purposes only.
  - name: password
    value: "{{ password }}"
    description: |
      The password to use when accessing the Managed Service.
  - name: username
    value: "{{ username }}"
    description: |
      The username to use when accessing the Managed Service.

REPLACE examples

update

Updates the label of a Managed Credential. This operation does not update the username and password for a Managed Credential. To do this, run the Update a managed credential's username and password) operation instead. This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

REPLACE linode.managed.credentials
SET 
label = '{{ label }}'
WHERE 
credentialId = '{{ credentialId }}' --required
RETURNING
id,
label,
last_decrypted;

Lifecycle Methods

revoke

Deletes a managed credential. Akamai Support will no longer have access to this credential when investigating or resolving issues.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

EXEC linode.managed.credentials.revoke 
@credentialId='{{ credentialId }}' --required
;

update_username_password

Updates the username and password for a managed credential.

This operation can only be accessed by the unrestricted users of an account.

Learn more...

Learn more...

EXEC linode.managed.credentials.update_username_password 
@credentialId='{{ credentialId }}' --required 
@@json=
'{
"password": "{{ password }}", 
"username": "{{ username }}"
}'
;