SparQDocs
GuidesAPI referencesparqhq.ai
API referenceAccess

Invite Member

POST
/v1/admin/workspaces/{workspace_id}/members

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

workspace_id*Workspace Id
Formatuuid

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
Idempotency-Key?string

Makes a retry safe: the same key, route and body within 24 hours returns the stored response and the same result id. The same key with a different body or route is idempotency_conflict; while the first request runs, idempotency_in_progress.

Length8 <= length <= 128

Request Body

application/json
  1. body
email*Email

Email address (stored lower-case).

Match^[^@\s]{1,64}@[^@\s]{1,255}\.[^@\s]{2,63}$
Lengthlength <= 320
name*Name
Length1 <= length <= 500

Response Body

Successful Response

application/json
  1. response

A person in a workspace. principal_id is set when they first sign in through the platform sign-in issuer with the invited email.

member_id*Member Id
Formatuuid
workspace_id*Workspace Id
Formatuuid
email*Email

Email address (stored lower-case).

Match^[^@\s]{1,64}@[^@\s]{1,255}\.[^@\s]{2,63}$
Lengthlength <= 320
name*Name
status*MemberStatus
Value in"invited""active""removed"
principal_id*string|null
invited_by_credential_id*Invited By Credential Id
Formatuuid
invited_at*Invited At
Formatdate-time
joined_at*|null
Example Request
curl -X POST 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/members' \  -H 'Content-Type: application/json' \  -d '{  "email": "ana@example.com",  "name": "string"}'
Example Response
{  "member_id": "435a4844-006a-4cfc-a644-e8eb2dd2ca43",  "workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",  "email": "ana@example.com",  "name": "string",  "status": "invited",  "principal_id": "string",  "invited_by_credential_id": "5947e677-91b6-4847-b387-f6dea4b45eb2",  "invited_at": "2019-08-24T14:15:22Z",  "joined_at": "2019-08-24T14:15:22Z"}

Create Sign In Issuer POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. Operators only: the identity provider console users sign in with.

Join Memberships POST

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version. Join every invitation that matches the signed-in person's email, binding it to this person; audited `member.join` in each workspace. Joining again changes nothing, so the call is safe to repeat without an `Idempotency-Key`.