Skip to content

Command-line sign-ins

Command-line sign-ins in the management API. 2 endpoints.

Read the guideOpenAPI 3.1 document

Try it settings

https://api.bifrostorbit.com/cms/manage/v1

The management API takes a management token, which is secret and acts as a person, so nothing here is sent from the docs.

Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.

Where people in the organisation are signed in with cms-orbit login

GET/organisations/{organisationId}/cli-sign-insKey required

Where people in the organisation are signed in with cms-orbit login. Signed-in people only. Permission: member:remove.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

Responses

  • 200OK[{ id, name, personId, person, signedInAt, lastUsedAt, endsAt, mine, canSignOut }].
    • dataCliSignIn[]

      Fields of data
      • idstring

        An id.

      • namestring

        The name cms-orbit registered with, or cms-orbit.

      • personIdstring

        An id.

      • personstring

        Who it acts as.

      • signedInAtstring

      • lastUsedAtstring or null

        Updated at most once a minute.

      • endsAtstring

        When it expires without use. Each renewal moves it to 30 days later.

      • mineboolean

      • canSignOutboolean

        Yours, or someone ranked below you.

  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks member:remove, which Admins and Owners have, or called with a token rather than a signed-in person.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such organisation, or it's in another organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/cli-sign-ins' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

Example answer

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f40a49",      "name": "CMS Orbit CLI on Ingrid's MacBook",      "personId": "6650f1c2a9e4b1d2c3f40a58",      "person": "Ingrid Berg",      "signedInAt": "2026-11-02T09:30:00.000Z",      "lastUsedAt": "2026-11-02T09:30:00.000Z",      "endsAt": "2026-11-02T09:30:00.000Z",      "mine": true,      "canSignOut": false    }  ]}

Signs one out at once, in every organisation its person belongs to

DELETE/organisations/{organisationId}/cli-sign-ins/{signInId}Key required

Signs one out at once, in every organisation its person belongs to. Signed-in people only. Signing out twice is fine. Permission: member:remove, for someone ranked below you or yourself.

Parameters

  • organisationIdstringpath, required

    The organisation's id, from the Management tokens page.

  • signInIdstringpath, required

    The sign in's id.

Responses

  • 204No contentDone, nothing to return.
  • 401UnauthorisedNo token, or a token that is unknown, expired or revoked, or whose person no longer has access.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 403ForbiddenLacks member:remove, the person ranks at or above you, or called with a token rather than a signed-in person.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 404Not foundNo such sign-in for anyone in the organisation.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

  • 500Server errorSomething went wrong on our side. Try again in a moment.
    • errorobject

      Fields of error
      • codestring

        One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
      • messagestring

        Follows Accept-Language when CMS Orbit has the language.

      • detailsanysometimes

        When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

Shell
curl -X DELETE 'https://api.bifrostorbit.com/cms/manage/v1/organisations/6650f1c2a9e4b1d2c3f40a01/cli-sign-ins/6650f1c2a9e4b1d2c3f40a30' \  -H 'Authorization: Bearer cms_mt_…'

Try it

Management tokens are secret and act as a person, so nothing is sent from the docs.

SchemasThe shapes the endpoints above answer with and take.

Error

Every error has this shape. Write code against code and the status, never the message.

  • errorobject

    Fields of error
    • codestring

      One of bad_request, unauthorized, forbidden, not_found, created_in_orbit, conflict, validation_failed, internal_error, unavailable.
    • messagestring

      Follows Accept-Language when CMS Orbit has the language.

    • detailsanysometimes

      When there is more to read. On 422, issues: each field that failed, with path, message and code. On a field value that breaks the content type's rules, a list of { path, message }. On a version conflict, currentVersion, expected and received.

CliSignIn

  • idstring

    An id.

  • namestring

    The name cms-orbit registered with, or cms-orbit.

  • personIdstring

    An id.

  • personstring

    Who it acts as.

  • signedInAtstring

  • lastUsedAtstring or null

    Updated at most once a minute.

  • endsAtstring

    When it expires without use. Each renewal moves it to 30 days later.

  • mineboolean

  • canSignOutboolean

    Yours, or someone ranked below you.