Approve a refused sign-in by creating its Member

POST /v1/members/sign-in-attempts/approve

Creates the Member of the attempt's email with the role, as invited until the next sign-in links it, and removes the attempt; not_found when no attempt has the email, validation_failed when a Member already holds it. From 1.51.0 its invitation lapses 72 hours later, as an invitation's does. From 1.34.0 a write that gives the operator role is refused with forbidden and the one detail operator_role_not_grantable, at path /role, in any Organization but the operator Organization, whoever asks, and there to any caller that does not hold the operator role; a write that keeps the role or takes it away is not a grant. Phase 0 accepts a Member ID token for this route, so an operator signed in to the cockpit makes the write.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the members:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X POST "$VOCAL_API/v1/members/sign-in-attempts/approve" \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{ "email": "<email>", "role": "owner" }'

const response = await fetch(`${process.env.VOCAL_API}/v1/members/sign-in-attempts/approve`, {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "email": "<email>",
    "role": "owner"
  }),
});
console.log(response.status, await response.text());

import os
import uuid

import requests

response = requests.post(
    f"{os.environ['VOCAL_API']}/v1/members/sign-in-attempts/approve",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "email": "<email>",
        "role": "owner",
    },
)
print(response.status_code, response.text)

Parameters

Request body

Content type application/json, required: SignInApproveRequest.

Responses

Fields of the 201 answer

The shape is Member.