members

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

Overview

Name	members
Type	Resource
Id	anthropic_admin.workspaces.members

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
user_id	string	ID of the User.
workspace_id	string	ID of the Workspace.
type	string	Object type. Always `workspace_member`. (workspace_member)
workspace_role	string	Role of the Workspace Member. (workspace_admin, workspace_billing, workspace_developer, workspace_restricted_developer, workspace_user)

list

Name	Datatype	Description
user_id	string	ID of the User.
workspace_id	string	ID of the Workspace.
type	string	Object type. Always `workspace_member`. (workspace_member)
workspace_role	string	Role of the Workspace Member. (workspace_admin, workspace_billing, workspace_developer, workspace_restricted_developer, workspace_user)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	workspace_id, user_id		Get a workspace member.
list	select	workspace_id	before_id, after_id	List members of a workspace.
create	insert	workspace_id, user_id, workspace_role		Add an organization member to a workspace. The role cannot be workspace_billing.
update	update	workspace_id, user_id, workspace_role		Update a workspace member's role.
delete	delete	workspace_id, user_id		Remove a member from a workspace.

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
user_id	string	ID of the User.
workspace_id	string	ID of the Workspace.
after_id	string	ID of the object to use as a cursor for pagination. Returns the page of results immediately after this object.
before_id	string	ID of the object to use as a cursor for pagination. Returns the page of results immediately before this object.

SELECT examples

get

Get a workspace member.

SELECT
user_id,
workspace_id,
type,
workspace_role
FROM anthropic_admin.workspaces.members
WHERE workspace_id = '{{ workspace_id }}' -- required
AND user_id = '{{ user_id }}' -- required
;

list

List members of a workspace.

SELECT
user_id,
workspace_id,
type,
workspace_role
FROM anthropic_admin.workspaces.members
WHERE workspace_id = '{{ workspace_id }}' -- required
AND before_id = '{{ before_id }}'
AND after_id = '{{ after_id }}'
;

INSERT examples

create

Add an organization member to a workspace. The role cannot be workspace_billing.

INSERT INTO anthropic_admin.workspaces.members (
user_id,
workspace_role,
workspace_id
)
SELECT 
'{{ user_id }}' /* required */,
'{{ workspace_role }}' /* required */,
'{{ workspace_id }}'
RETURNING
user_id,
workspace_id,
type,
workspace_role
;

Manifest

# Description fields are for documentation purposes
- name: members
props:
  - name: workspace_id
    value: "{{ workspace_id }}"
    description: Required parameter for the members resource.
  - name: user_id
    value: "{{ user_id }}"
    description: |
      ID of the User.
  - name: workspace_role
    value: "{{ workspace_role }}"
    description: |
      Role of the new Workspace Member. Cannot be `workspace_billing`.
    valid_values: ['workspace_admin', 'workspace_developer', 'workspace_restricted_developer', 'workspace_user']

UPDATE examples

update

Update a workspace member's role.

UPDATE anthropic_admin.workspaces.members
SET 
workspace_role = '{{ workspace_role }}'
WHERE 
workspace_id = '{{ workspace_id }}' --required
WHERE user_id = '{{ user_id }}' --required
AND workspace_role = '{{ workspace_role }}' --required
RETURNING
user_id,
workspace_id,
type,
workspace_role;

DELETE examples

delete

Remove a member from a workspace.

DELETE FROM anthropic_admin.workspaces.members
WHERE workspace_id = '{{ workspace_id }}' --required
AND user_id = '{{ user_id }}' --required
;