Sign in
public-api-tokens

Changed on

Create a SystemUser and ResourceAccess rows; return the plaintext token once.

Returns HTTP 201 on success. The response body includes id, integration_name, is_active, available_resources, and a write-once token field — never long_lived_token_hash.

HTTP 400 is returned for:

  • Invalid or unknown available_resources values.
  • Empty available_resources list.
  • Duplicate integration_name (unique constraint).

HTTP 403 is returned for non-admin callers; HTTP 401 for unauthenticated.

post/public-api-tokens{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Request body

integration_namestring required
available_resourcesAvailableResourcesEnum[] required
scoped_to_userinteger nullable

Response

idinteger required
integration_namestring required
is_activeboolean required

Indicates if the user is active.

available_resourcesstring[] required

Return a list of resource_name values from the related ResourceAccess rows.

scoped_to_userinteger nullable required

Return the owner's User id from the denormalized membership column, or None.

scoped_to_membership_user_id already stores the membership's user_id, so the value is returned directly with no extra query.

tokenstring required

Changes

  • e92afcb6b029Revision changes
    • ▲

      removed the enum value batch_upsert_group_scoped_availability_windows of the request property / (media type: application/json)

    • ▲

      removed the enum value batch_upsert_group_scoped_availability_windows of the request property / (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value batch_upsert_group_scoped_availability_windows of the request property / (media type: multipart/form-data)

    • ▲

      removed the enum value batch_upsert_group_scoped_blocked_times of the request property / (media type: application/json)

    • ▲

      removed the enum value batch_upsert_group_scoped_blocked_times of the request property / (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value batch_upsert_group_scoped_blocked_times of the request property / (media type: multipart/form-data)

    • ▲

      removed the enum value batch_upsert_group_scoped_quota_rules of the request property / (media type: application/json)

    • ▲

      removed the enum value batch_upsert_group_scoped_quota_rules of the request property / (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value batch_upsert_group_scoped_quota_rules of the request property / (media type: multipart/form-data)

    • ▲

      removed the enum value calendar_group of the request property / (media type: application/json)

    • ▲

      removed the enum value calendar_group of the request property / (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value calendar_group of the request property / (media type: multipart/form-data)

    • ▲

      removed the enum value group_scoped_availability_windows of the request property / (media type: application/json)

    • ▲

      removed the enum value group_scoped_availability_windows of the request property / (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value group_scoped_availability_windows of the request property / (media type: multipart/form-data)

    • ▲

      removed the enum value group_scoped_blocked_times of the request property / (media type: application/json)

    • ▲

      removed the enum value group_scoped_blocked_times of the request property / (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value group_scoped_blocked_times of the request property / (media type: multipart/form-data)

    • ▲

      removed the enum value group_scoped_quota_rules of the request property / (media type: application/json)

    • ▲

      removed the enum value group_scoped_quota_rules of the request property / (media type: application/x-www-form-urlencoded)

    • ▲

      removed the enum value group_scoped_quota_rules of the request property / (media type: multipart/form-data)

    • ○

      added the new appointment_type enum value to the request property / (media type: application/json)

    • ○

      added the new appointment_type enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new appointment_type enum value to the request property / (media type: multipart/form-data)

    • ○

      added the new appointment_type_scoped_availability_windows enum value to the request property / (media type: application/json)

    • ○

      added the new appointment_type_scoped_availability_windows enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new appointment_type_scoped_availability_windows enum value to the request property / (media type: multipart/form-data)

    • ○

      added the new appointment_type_scoped_blocked_times enum value to the request property / (media type: application/json)

    • ○

      added the new appointment_type_scoped_blocked_times enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new appointment_type_scoped_blocked_times enum value to the request property / (media type: multipart/form-data)

    • ○

      added the new appointment_type_scoped_quota_rules enum value to the request property / (media type: application/json)

    • ○

      added the new appointment_type_scoped_quota_rules enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new appointment_type_scoped_quota_rules enum value to the request property / (media type: multipart/form-data)

    • ○

      added the new batch_upsert_appointment_type_scoped_availability_windows enum value to the request property / (media type: application/json)

    • ○

      added the new batch_upsert_appointment_type_scoped_availability_windows enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new batch_upsert_appointment_type_scoped_availability_windows enum value to the request property / (media type: multipart/form-data)

    • ○

      added the new batch_upsert_appointment_type_scoped_blocked_times enum value to the request property / (media type: application/json)

    • ○

      added the new batch_upsert_appointment_type_scoped_blocked_times enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new batch_upsert_appointment_type_scoped_blocked_times enum value to the request property / (media type: multipart/form-data)

    • ○

      added the new batch_upsert_appointment_type_scoped_quota_rules enum value to the request property / (media type: application/json)

    • ○

      added the new batch_upsert_appointment_type_scoped_quota_rules enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new batch_upsert_appointment_type_scoped_quota_rules enum value to the request property / (media type: multipart/form-data)

  • 722e2911db6eRevision changes
    • ○

      added the new calendar_pool enum value to the request property / (media type: application/json)

    • ○

      added the new calendar_pool enum value to the request property / (media type: application/x-www-form-urlencoded)

    • ○

      added the new calendar_pool enum value to the request property / (media type: multipart/form-data)