What are permissions?

Permissions are named access controls you create and then link to plans or individual members. They let you gate content or features based on what a member has access to.

Can I link multiple permissions at once?

Yes. The link-plan and link-member commands accept multiple --permission-id flags to link several permissions in a single command.

What is the difference between linking to a plan vs a member?

Linking to a plan gives the permission to every member on that plan. Linking to a member gives the permission to that specific member only, regardless of their plan.

Permissions | Memberstack CLI

memberstack permissions <subcommand> [options]

permissions list

List all permissions.

memberstack permissions list

Example

$ memberstack permissions list
ID              Name            Description
perm_abc123     edit-posts      Can edit posts
perm_def456     view-dashboard  Can view the dashboard

permissions create

Create a permission.

memberstack permissions create [options]

Options

Option	Description	Required
`--name <name>`	Permission name	Yes
`--description <desc>`	Permission description	No

Examples

memberstack permissions create --name edit-posts
memberstack permissions create --name view-dashboard --description "Can view the dashboard"

permissions update

Update a permission.

memberstack permissions update <permissionId> [options]

Arguments

Argument	Description	Required
`permissionId`	Permission ID to update	Yes

Options

Option	Description
`--name <name>`	Permission name
`--description <desc>`	Permission description

Example

memberstack permissions update perm_abc123 --name edit-all-posts --description "Can edit all posts"

permissions delete

Delete a permission.

memberstack permissions delete <permissionId>

Arguments

Argument	Description	Required
`permissionId`	Permission ID to delete	Yes

Example

memberstack permissions delete perm_abc123

permissions link-plan

Link permissions to a plan.

memberstack permissions link-plan [options]

Options

Option	Description	Required
`--plan-id <id>`	Plan ID	Yes
`--permission-id <id>`	Permission ID (repeatable)	Yes

Examples

memberstack permissions link-plan --plan-id pln_abc123 --permission-id perm_def456
memberstack permissions link-plan --plan-id pln_abc123 --permission-id perm_def456 --permission-id perm_ghi789

permissions unlink-plan

Unlink a permission from a plan.

memberstack permissions unlink-plan [options]

Options

Option	Description	Required
`--plan-id <id>`	Plan ID	Yes
`--permission-id <id>`	Permission ID	Yes

Example

memberstack permissions unlink-plan --plan-id pln_abc123 --permission-id perm_def456

permissions link-member

Link permissions to a member.

memberstack permissions link-member [options]

Options

Option	Description	Required
`--member-id <id>`	Member ID	Yes
`--permission-id <id>`	Permission ID (repeatable)	Yes

Examples

memberstack permissions link-member --member-id mem_abc123 --permission-id perm_def456
memberstack permissions link-member --member-id mem_abc123 --permission-id perm_def456 --permission-id perm_ghi789

permissions unlink-member

Unlink a permission from a member.

memberstack permissions unlink-member [options]

Options

Option	Description	Required
`--member-id <id>`	Member ID	Yes
`--permission-id <id>`	Permission ID	Yes

Example

memberstack permissions unlink-member --member-id mem_abc123 --permission-id perm_def456

Permissions

permissions list

Example

permissions create

Options

Examples

permissions update

Arguments

Options

Example

permissions delete

Arguments

Example

permissions link-plan

Options

Examples

permissions unlink-plan

Options

Example

permissions link-member

Options

Examples

permissions unlink-member

Options

Example

FAQ

On this page