Add workspace member

POST

https://host.com/apis/entities/v2/workspaces/:workspace/members

Add a new member to the workspace with specified roles.

This creates role bindings for the specified principal with the given roles. By default, this endpoint waits for the roles to propagate before returning. Use wait_role_propagation=false to skip waiting (useful for bulk operations).

Example:

POST /apis/entities/v2/workspaces/ml-team/members
{
    "principal": "user@example.com",
    "roles": ["Editor"]
}

Add a new member to the workspace with specified roles. This creates role bindings for the specified principal with the given roles. By default, this endpoint waits for the roles to propagate before returning. Use `wait_role_propagation=false` to skip waiting (useful for bulk operations). Example: ``` POST /apis/entities/v2/workspaces/ml-team/members { "principal": "user@example.com", "roles": ["Editor"] } ```

Path parameters

workspacestringRequired

Query parameters

wait_role_propagationbooleanOptionalDefaults to true

If true, wait for roles to propagate before returning (default: true). Set to false for bulk operations.

Request

This endpoint expects an object.

principalstringRequired

The principal identifier (email, user ID, or group ID)

roleslist of stringsOptionalDefaults to ["Editor"]

List of roles to grant to the principal

Response

Successful Response

principalstring

The principal identifier

roleslist of strings

List of roles granted to the principal

granted_atdatetime

Earliest date when a role was granted to this principal

granted_bystring

Who granted the earliest role

Errors

422

Unprocessable Entity Error

$	curl -X POST https://host.com/apis/entities/v2/workspaces/workspace/members \
>	-H "Content-Type: application/json" \
>	-d '{
>	"principal": "alice.smith@techcorp.com"
>	}'

1	{
2	"principal": "alice.smith@techcorp.com",
3	"roles": [
4	"Editor"
5	],
6	"granted_at": "2024-01-15T09:30:00Z",
7	"granted_by": "admin@techcorp.com"
8	}