sharegroup_members

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

Overview

Name	sharegroup_members
Type	Resource
Id	linode.images.sharegroup_members

Fields

The following fields are returned by SELECT queries:

get

A single token object.

Name	Datatype	Description
created	string (date-time)	Read-only When the user became the share group's member. (example: 2025-08-04T10:07:59)
expiry	string (date-time)	Read-only When the user's share group membership expires.
label	string	The share group member's descriptive name. (example: Engineering - Backend)
status	string	Read-only The current membership status. Share group members can be active or revoked. Revoked members' data remains available for two weeks after they left a share group. (active, revoked) (example: active)
token_uuid	string	Read-only The membership token's unique identifier. Not to be confused with the token needed to add a member to the share group. (example: 4591075e-4ba8-43c9-a521-928c3d4a135d)
updated	string (date-time)	Read-only When the user's share group membership was last updated.

list

Returns a paginated list of the current members linked to the targeted share group.

Name	Datatype	Description
created	string (date-time)	Read-only When the user became the share group's member. (example: 2025-08-04T10:07:59)
expiry	string (date-time)	Read-only When the user's share group membership expires.
label	string	Filterable The share group member's descriptive name. (example: Engineering - Backend)
status	string	Filterable, Read-only The current membership status. Share group members can be active or revoked. Revoked members' data remains available for two weeks after they left a share group. (active, revoked) (example: active)
token_uuid	string	Filterable, Read-only The membership token's unique identifier. Not to be confused with the token needed to add a member to the share group. (example: 4591075e-4ba8-43c9-a521-928c3d4a135d)
updated	string (date-time)	Read-only When the user's share group membership was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	sharegroupId, tokenUuid		Get details about a membership token as a share group owner. Run this operation to check the status of a pending membership request or a current group member. - Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group. - Get the token_uuid from the user who wants to join your share group or run the List members by share group operation for details on current group members. - To get details about a token as a current or pending group member, run the Get a token operation. Learn more... Learn more...
list	select	sharegroupId		Get the details about all members in a particular share group you own. - Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group. Learn more... Learn more...
create	insert	sharegroupId, token, label		Adds users to existing shared private image groups as a group owner. - Adding new members to share groups requires a single-use token. The user who wants to join a share group should run Create a token and share the token from the response with the group owner. - Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group. Learn more... Learn more...
update	replace	sharegroupId, tokenUuid, label		Updates an existing membership token for a group owner. You can change each token's label that will be visible only to you, such as when you Get members by share group. - Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group. - Run the List members by share group operation to get the token_uuid for a current group member. Learn more... Learn more...
delete	delete	sharegroupId, tokenUuid		Revokes a membership token accepted into a share group. Members with revoked status immediately lose access to shared images, and can't deploy them anymore. - Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group. - Run the List members by share group operation to get the token_uuid for a current group member. After revoking a membership, you can run this operation to check its status. 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
sharegroupId	string	The share group's unique identifier assigned after creating it. Not to be confused with the group's uuid.
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 owner. Run this operation to check the status of a pending membership request or a current group member.

- Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group.

- Get the token_uuid from the user who wants to join your share group or run the List members by share group operation for details on current group members.

- To get details about a token as a current or pending group member, run the Get a token operation.

Learn more...

Learn more...

SELECT
created,
expiry,
label,
status,
token_uuid,
updated
FROM linode.images.sharegroup_members
WHERE sharegroupId = '{{ sharegroupId }}' -- required
AND tokenUuid = '{{ tokenUuid }}' -- required
;

list

Get the details about all members in a particular share group you own.

- Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group.

Learn more...

Learn more...

SELECT
created,
expiry,
label,
status,
token_uuid,
updated
FROM linode.images.sharegroup_members
WHERE sharegroupId = '{{ sharegroupId }}' -- required
;

INSERT examples

create

Adds users to existing shared private image groups as a group owner.

- Adding new members to share groups requires a single-use token. The user who wants to join a share group should run Create a token and share the token from the response with the group owner.

- Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group.

Learn more...

Learn more...

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

Manifest

# Description fields are for documentation purposes
- name: sharegroup_members
props:
  - name: sharegroupId
    value: "{{ sharegroupId }}"
    description: Required parameter for the sharegroup_members resource.
  - name: label
    value: "{{ label }}"
    description: |
      The share group member's descriptive name.
  - name: token
    value: "{{ token }}"
    description: |
      The single-use JWT membership token encoded as a string. It consists of three parts: header, payload, and signature. If needed, the user should [Create a token](https://techdocs.akamai.com/linode-api/reference/post-sharegroup-tokens) and share it with the group owner before joining.

REPLACE examples

update

Updates an existing membership token for a group owner. You can change each token's label that will be visible only to you, such as when you Get members by share group.

- Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group.

- Run the List members by share group operation to get the token_uuid for a current group member.

Learn more...

Learn more...

REPLACE linode.images.sharegroup_members
SET 
label = '{{ label }}'
WHERE 
sharegroupId = '{{ sharegroupId }}' --required
AND tokenUuid = '{{ tokenUuid }}' --required
AND label = '{{ label }}' --required
RETURNING
created,
expiry,
label,
status,
token_uuid,
updated;

DELETE examples

delete

Revokes a membership token accepted into a share group. Members with revoked status immediately lose access to shared images, and can't deploy them anymore.

- Run the List share groups operation to get the id you should use as the (sharegroupId) path parameter that identifies an existing share group.

- Run the List members by share group operation to get the token_uuid for a current group member. After revoking a membership, you can run this operation to check its status.

Learn more...

Learn more...

DELETE FROM linode.images.sharegroup_members
WHERE sharegroupId = '{{ sharegroupId }}' --required
AND tokenUuid = '{{ tokenUuid }}' --required
;