workspace_members

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

Overview

Name	workspace_members
Type	Resource
Id	railway.workspaces.workspace_members

Fields

The following fields are returned by SELECT queries:

list

One row per WorkspaceMember.

Name	Datatype	Description
id	string
name	string
avatar	string
email	string
feature_flags	array	Only retrieved if requested by an admin
role	string	(ADMIN, MEMBER, VIEWER)
two_factor_auth_enabled	boolean	Only retrieved if requested by an admin

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	workspace_id		Lists WorkspaceMember objects of a Workspace. Backed by the Railway GraphQL query workspace.members.
invite	insert	code, email, workspace_id		Invite a user by email to a workspace. Backed by the Railway GraphQL mutation workspaceUserInvite.
update	update	role, user_id, workspace_id		Changes a user workspace permissions. Backed by the Railway GraphQL mutation workspacePermissionChange.
remove	delete	user_id, workspace_id		Remove a user from a workspace. Backed by the Railway GraphQL mutation workspaceUserRemove.

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
workspace_id	string
code	string
email	string
role	string	(ADMIN, MEMBER, VIEWER)
user_id	string

SELECT examples

list

Lists WorkspaceMember objects of a Workspace. Backed by the Railway GraphQL query workspace.members.

SELECT
id,
name,
avatar,
email,
feature_flags,
role,
two_factor_auth_enabled
FROM railway.workspaces.workspace_members
WHERE workspace_id = '{{ workspace_id }}' -- required
;

INSERT examples

invite

Invite a user by email to a workspace. Backed by the Railway GraphQL mutation workspaceUserInvite.

INSERT INTO railway.workspaces.workspace_members (
code,
email,
workspace_id
)
SELECT 
'{{ code }}' /* required */,
'{{ email }}' /* required */,
'{{ workspace_id }}' /* required */
RETURNING
result
;

Manifest

# Description fields are for documentation purposes
- name: workspace_members
props:
  - name: code
    value: "{{ code }}"
  - name: email
    value: "{{ email }}"
  - name: workspace_id
    value: "{{ workspace_id }}"

UPDATE examples

update

Changes a user workspace permissions. Backed by the Railway GraphQL mutation workspacePermissionChange.

UPDATE railway.workspaces.workspace_members
SET 

WHERE 
role = '{{ role }}' --required
AND user_id = '{{ user_id }}' --required
AND workspace_id = '{{ workspace_id }}' --required
RETURNING
result;

DELETE examples

remove

Remove a user from a workspace. Backed by the Railway GraphQL mutation workspaceUserRemove.

DELETE FROM railway.workspaces.workspace_members
WHERE 
user_id = '{{ user_id }}' --required
AND workspace_id = '{{ workspace_id }}' --required
;