CLICommand referenceaccess

access

Commands, arguments, and options for openship access.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship access

Manage workspaces, members, invitations and resource grants

openship access [options] [command]
SubcommandPurpose
workspacesList accessible workspaces and whether this credential can select an organization
organizationShow the current organization and member count
create-team [options] <name>Create a team workspace; select its ID with the global --organization option
resources [options] <type>List resources available for permission grants
membersManage membership in the selected workspace
grantsManage per-resource access grants
invitationsManage workspace invitations

openship access create-team

Create a team workspace; select its ID with the global --organization option

openship access create-team [options] <name>
ArgumentMeaning
nameWorkspace name
OptionMeaning
--slug <slug>Workspace slug

openship access grants

Manage per-resource access grants

openship access grants [options] [command]
SubcommandPurpose
list <user>List a user's resource grants
set <file>Create or update one resource grant
replace [options] <file>Replace a user's complete resource grant set
remove <id>Revoke one resource grant

openship access grants list

List a user's resource grants

openship access grants list [options] <user>
ArgumentMeaning
userUser ID

openship access grants remove

Revoke one resource grant

openship access grants remove [options] <id>
ArgumentMeaning
idGrant ID

openship access grants replace

Replace a user's complete resource grant set

openship access grants replace [options] <file>
ArgumentMeaning
fileJSON object with userId and the complete grants array
OptionMeaning
-y, --yesSkip confirmation

openship access grants set

Create or update one resource grant

openship access grants set [options] <file>
ArgumentMeaning
fileJSON grant with userId, resourceType, resourceId and permissions

openship access members

Manage membership in the selected workspace

openship access members [options] [command]
SubcommandPurpose
listList workspace members
role <id> <role>Change a member's role through the shared permission rules
remove [options] <id>Remove a workspace member

openship access members list

List workspace members

openship access members list [options]

openship access members remove

Remove a workspace member

openship access members remove [options] <id>
ArgumentMeaning
idMember ID
OptionMeaning
-y, --yesSkip confirmation

openship access members role

Change a member's role through the shared permission rules

openship access members role [options] <id> <role>
ArgumentMeaning
idMember ID
roleowner | admin | member | restricted

openship access organization

Show the current organization and member count

openship access organization [options]

openship access resources

List resources available for permission grants

openship access resources [options] <type>
ArgumentMeaning
typeResource type
OptionMeaning
--owner <id>Resource owner filter

openship access workspaces

List accessible workspaces and whether this credential can select an organization

openship access workspaces [options]

On this page