sharegroup_tokens

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

Overview

Name	sharegroup_tokens
Type	Resource
Id	linode.images.sharegroup_tokens

Fields

The following fields are returned by SELECT queries:

get

A single token object.

Name	Datatype	Description
created	string (date-time)	Read-only When this token was created. (example: 2025-08-04T10:09:09)
expiry	string (date-time)	Read-only When this token expires.
label	string	A short description of the token. (example: Backend Services - Engineering)
sharegroup_label	string	Read-only The share group's descriptive name. (example: DevOps Base Images)
sharegroup_uuid	string	Read-only The share group's unique identifier. (example: e1d0e58b-f89f-4237-84ab-b82077342359)
status	string	Read-only Represents the current token status. - pending: The token has been created but is not yet active. - active: The token is currently active and usable. - revoked: The token has been deleted and is no longer valid. - expired: The token has passed its validity period and is no longer usable. (pending, active, revoked, expired) (example: active)
token_uuid	string	Read-only A unique identifier for the token, used to reference it after creation. (example: 13428362-5458-4dad-b14b-8d0d4d648f8c)
updated	string (date-time)	Read-only When this token was last updated.
valid_for_sharegroup_uuid	string	Read-only The unique identifier of the share group you created a token for. (example: e1d0e58b-f89f-4237-84ab-b82077342359)

list

Returns a paginated list of the tokens.

Name	Datatype	Description
created	string (date-time)	Read-only The creation time of this token. (example: 2025-08-04T10:09:09)
expiry	string (date-time)	Read-only The time when this token expires.
label	string	Filterable A short description of the token. (example: Backend Services - Engineering)
sharegroup_label	string	Filterable, Read-only Associated share group label. (example: DevOps Base Images)
sharegroup_uuid	string	Filterable, Read-only The unique identifier of the share group you created a token for. (example: e1d0e58b-f89f-4237-84ab-b82077342359)
status	string	Filterable, Read-only Represents the current token status. - pending: The token has been created but is not yet active. - active: The token is currently active and usable. - revoked: The token has been deleted and is no longer valid. - expired: The token has passed its validity period and is no longer usable. (pending, active, revoked, expired) (example: active)
token_uuid	string	Read-only A unique identifier for the token, used to reference it after creation. (example: 13428362-5458-4dad-b14b-8d0d4d648f8c)
updated	string (date-time)	Read-only The time when this token was last updated.
valid_for_sharegroup_uuid	string	Filterable, Read-only UUID identifying the associated share group. (example: e1d0e58b-f89f-4237-84ab-b82077342359)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	tokenUuid		Get details about a membership token as a share group member. Run this operation to check the status of a pending membership request or your current group membership. - To get the token_uuid, run the List tokens or Create a token operation to generate one for the share group you want to join. Learn more... Learn more...
list	select			Get details about all the user's tokens. Learn more... Learn more...
create	insert	valid_for_sharegroup_uuid		Creates a single-use membership token for users who want to join a share group with custom images. - Before creating a token, get the share group's UUID from its owner. The owner can run List share groups or Get a share group to get the group's UUID. If needed, Create a share group and share the UUID with the user. - Share the token from the response with the share group owner. The owner can later use the token to Add members to a share group and manage the users' membership within the group. Learn more... Learn more...
update	replace	tokenUuid, label		Updates the label of an existing membership token for a share group member or a pending membership. To get the token_uuid, run the List tokens or Create a token operation to generate one for the share group you want to join. Learn more... Learn more...
delete	delete	tokenUuid		Removes an existing membership token for a share group member or a pending membership. - To get the token_uuid, run the List tokens operation. 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
tokenUuid	string (uuid)	A unique identifier for the token, used to reference it after creation.

SELECT examples

get

Get details about a membership token as a share group member. Run this operation to check the status of a pending membership request or your current group membership.

- To get the token_uuid, run the List tokens or Create a token operation to generate one for the share group you want to join.

Learn more...

Learn more...

SELECT
created,
expiry,
label,
sharegroup_label,
sharegroup_uuid,
status,
token_uuid,
updated,
valid_for_sharegroup_uuid
FROM linode.images.sharegroup_tokens
WHERE tokenUuid = '{{ tokenUuid }}' -- required
;

list

Get details about all the user's tokens.

Learn more...

Learn more...

SELECT
created,
expiry,
label,
sharegroup_label,
sharegroup_uuid,
status,
token_uuid,
updated,
valid_for_sharegroup_uuid
FROM linode.images.sharegroup_tokens
;

INSERT examples

create

Creates a single-use membership token for users who want to join a share group with custom images.

- Before creating a token, get the share group's UUID from its owner. The owner can run List share groups or Get a share group to get the group's UUID. If needed, Create a share group and share the UUID with the user.

- Share the token from the response with the share group owner. The owner can later use the token to Add members to a share group and manage the users' membership within the group.

Learn more...

Learn more...

INSERT INTO linode.images.sharegroup_tokens (
label,
valid_for_sharegroup_uuid
)
SELECT 
'{{ label }}',
'{{ valid_for_sharegroup_uuid }}' /* required */
RETURNING
created,
expiry,
label,
sharegroup_label,
sharegroup_uuid,
status,
token,
token_uuid,
updated,
valid_for_sharegroup_uuid
;

Manifest

# Description fields are for documentation purposes
- name: sharegroup_tokens
props:
  - name: label
    value: "{{ label }}"
    description: |
      The token's descriptive name.
  - name: valid_for_sharegroup_uuid
    value: "{{ valid_for_sharegroup_uuid }}"
    description: |
      The unique identifier of the share group you want to create a token for.

REPLACE examples

update

Updates the label of an existing membership token for a share group member or a pending membership.

To get the token_uuid, run the List tokens or Create a token operation to generate one for the share group you want to join.

Learn more...

Learn more...

REPLACE linode.images.sharegroup_tokens
SET 
label = '{{ label }}'
WHERE 
tokenUuid = '{{ tokenUuid }}' --required
AND label = '{{ label }}' --required
RETURNING
created,
expiry,
label,
sharegroup_label,
sharegroup_uuid,
status,
token_uuid,
updated,
valid_for_sharegroup_uuid;

DELETE examples

delete

Removes an existing membership token for a share group member or a pending membership.

- To get the token_uuid, run the List tokens operation.

Learn more...

Learn more...

DELETE FROM linode.images.sharegroup_tokens
WHERE tokenUuid = '{{ tokenUuid }}' --required
;