Admin Sign In

Generated admin sign in operations.

GET/v1/admin/sign-inManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: get_sign_in_settings

Responses

200Successapplication/json

Example

{
  "move": {
    "devices": 0,
    "from": "portico",
    "id": "id_8h2k4q",
    "invitations": 0,
    "ownAddressRequired": true,
    "people": 0,
    "profiles": 0,
    "removedProfiles": 0,
    "retainedProfiles": 0,
    "revision": 0,
    "serverName": "Fargo",
    "stage": "string",
    "startOver": true,
    "to": "portico",
    "waiting": 0
  },
  "owner": {
    "accountId": "id_8h2k4q",
    "displayName": "Fargo",
    "email": "sam@example.com",
    "username": "Fargo"
  },
  "signIn": "portico",
  "webPath": "string"
}

Schema

moveobject | any | nullrequired
- devicesinteger
- fromstringrequiredone of "portico", "local"
- idstringrequired
- invitationsintegerrequired
- ownAddressRequiredbooleanrequired
- peopleintegerrequired
- profilesintegerrequired
- removedProfilesinteger
- retainedProfilesinteger
- revisionintegerrequired
- serverNamestringrequired
- stagestringrequired
- startOverbooleanrequired
- tostringrequiredone of "portico", "local"
- waitingintegerrequired
ownerobjectrequired
- accountIdstringrequired
- displayNamestringrequired
- emailstring
- usernamestringrequired
signInstringrequiredone of "portico", "local"
webPathstringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/sign-in" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

GET/v1/admin/sign-in/moveManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: get_sign_in_move

Responses

200Successapplication/json

Example

{
  "move": {
    "devices": 0,
    "from": "portico",
    "id": "id_8h2k4q",
    "invitations": 0,
    "ownAddressRequired": true,
    "people": 0,
    "profiles": 0,
    "removedProfiles": 0,
    "retainedProfiles": 0,
    "revision": 0,
    "serverName": "Fargo",
    "stage": "string",
    "startOver": true,
    "to": "portico",
    "waiting": 0
  }
}

Schema

moveobject | any | nullrequired
- devicesinteger
- fromstringrequiredone of "portico", "local"
- idstringrequired
- invitationsintegerrequired
- ownAddressRequiredbooleanrequired
- peopleintegerrequired
- profilesintegerrequired
- removedProfilesinteger
- retainedProfilesinteger
- revisionintegerrequired
- serverNamestringrequired
- stagestringrequired
- startOverbooleanrequired
- tostringrequiredone of "portico", "local"
- waitingintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/sign-in/move" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

POST/v1/admin/sign-in/move/{id}/cancelManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_sign_in_move_cancel
Max body: 16 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "expectedRevision": 0
}

Schema

expectedRevisionintegerrequired

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/sign-in/move/{id}/cancel" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0}'

POST/v1/admin/sign-in/move/{id}/finishManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_sign_in_move_finish
Max body: 16 KiB

Parameters

Name	In	Type	Description
`id`required	path	`string`

Request body application/json · required

Example

{
  "expectedRevision": 0
}

Schema

expectedRevisionintegerrequired

Responses

204Success

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/sign-in/move/{id}/finish" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"expectedRevision":0}'

POST/v1/admin/sign-in/move/codesManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_sign_in_move_codes
Max body: 16 KiB

Request body application/json · required

Example

{
  "accountIds": [
    "string"
  ],
  "expectedRevision": 0,
  "moveId": "id_8h2k4q"
}

Schema

accountIdsarray of stringrequired
expectedRevisioninteger
moveIdstring

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "accountId": "id_8h2k4q",
      "code": "string",
      "expiresAt": "2026-10-18T19:30:00Z",
      "serverId": "id_8h2k4q",
      "username": "Fargo"
    }
  ]
}

Schema

itemsarray of objectrequired
- accountIdstringrequired
- codestringrequired
- expiresAtstringrequired
- serverIdstring
- usernamestringrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/sign-in/move/codes" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"accountIds":["string"],"expectedRevision":0,"moveId":"id_8h2k4q"}'

POST/v1/admin/sign-in/move/confirmManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_sign_in_move_confirm
Max body: 16 KiB

Request body application/json · required

Example

{
  "confirmation": "string",
  "expectedRevision": 0,
  "moveId": "id_8h2k4q",
  "password": "string",
  "username": "Fargo"
}

Schema

confirmationstringrequired
expectedRevisionintegerrequired
moveIdstringrequired
passwordstringrequired
usernamestringrequired

Responses

200Successapplication/json

Example

{
  "move": {
    "devices": 0,
    "from": "portico",
    "id": "id_8h2k4q",
    "invitations": 0,
    "ownAddressRequired": true,
    "people": 0,
    "profiles": 0,
    "removedProfiles": 0,
    "retainedProfiles": 0,
    "revision": 0,
    "serverName": "Fargo",
    "stage": "string",
    "startOver": true,
    "to": "portico",
    "waiting": 0
  },
  "signIn": {
    "account": {
      "allowedLibraries": [
        "string"
      ],
      "disabled": true,
      "disabledAt": "2026-10-18T19:30:00Z",
      "disabledReason": "string",
      "hostedAccountId": "id_8h2k4q",
      "id": "id_8h2k4q",
      "primaryProfileId": "id_8h2k4q",
      "revision": 0,
      "role": "string",
      "username": "Fargo"
    },
    "authority": "string",
    "canManage": true,
    "capabilities": {
      "manageAccount": true,
      "managePeople": true,
      "manageServer": true,
      "manageSignIn": true
    },
    "challenge": {
      "expiresAt": "2026-10-18T19:30:00Z",
      "token": "string"
    },
    "custodyPending": true,
    "deviceId": "id_8h2k4q",
    "installationId": "id_8h2k4q",
    "managePinRequired": true,
    "passwordChangeRequired": true,
    "profiles": [
      {
        "allowedLibraries": [
          "string"
        ],
        "art": "string",
        "id": "id_8h2k4q",
        "name": "Fargo",
        "pinRequired": true,
        "pinRevision": 0,
        "position": 0,
        "primary": true,
        "revision": 0
      }
    ],
    "rememberProfiles": true,
    "resetFileOwnerSession": true,
    "serverId": "id_8h2k4q",
    "session": {
      "accessToken": "string",
      "authorizationHorizon": "string",
      "deviceId": "id_8h2k4q",
      "expiresAt": "2026-10-18T19:30:00Z",
      "installationId": "id_8h2k4q",
      "refreshToken": "string",
      "serverIdentity": {
        "fingerprint": "string",
        "publicKey": "string"
      },
      "sessionFamilyId": "id_8h2k4q",
      "tokenGeneration": "string",
      "viewer": {
        "accountId": "id_8h2k4q",
        "authority": "string",
        "profileId": "id_8h2k4q",
        "role": "string",
        "serverId": "id_8h2k4q"
      }
    },
    "twoStepSetupRequired": true
  }
}

Schema

moveobject
- devicesinteger
- fromstringrequiredone of "portico", "local"
- idstringrequired
- invitationsintegerrequired
- ownAddressRequiredbooleanrequired
- peopleintegerrequired
- profilesintegerrequired
- removedProfilesinteger
- retainedProfilesinteger
- revisionintegerrequired
- serverNamestringrequired
- stagestringrequired
- startOverbooleanrequired
- tostringrequiredone of "portico", "local"
- waitingintegerrequired
signInobject
- accountobjectrequired
  - allowedLibrariesarray of stringrequired
  - disabledbooleanrequired
  - disabledAtstring
  - disabledReasonstring
  - hostedAccountIdstring
  - idstringrequired
  - primaryProfileIdstringrequired
  - revisionintegerrequired
  - rolestringrequired
  - usernamestringrequired
- authoritystringrequired
- canManagebooleanrequired
- capabilitiesobjectrequired
  - manageAccountbooleanrequired
  - managePeoplebooleanrequired
  - manageServerbooleanrequired
  - manageSignInbooleanrequired
- challengeobject
  - expiresAtstringrequired
  - tokenstringrequired
- custodyPendingboolean
- deviceIdstring
- installationIdstring
- managePinRequiredboolean
- passwordChangeRequiredboolean
- profilesarray of objectrequired
  - allowedLibrariesarray of stringrequired
  - artstringrequired
  - idstringrequired
  - namestringrequired
  - pinRequiredbooleanrequired
  - pinRevisionintegerrequired
  - positionintegerrequired
  - primarybooleanrequired
  - revisionintegerrequired
- rememberProfilesbooleanrequired
- resetFileOwnerSessionboolean
- serverIdstringrequired
- sessionobject
  - accessTokenstringrequired
  - authorizationHorizonstringrequired
  - deviceIdstringrequired
  - expiresAtstringrequired
  - installationIdstringrequired
  - refreshTokenstring
  - serverIdentityobject
    fingerprintstringrequired
    publicKeystringrequired
  - sessionFamilyIdstringrequired
  - tokenGenerationstringrequired
  - viewerobjectrequired
    accountIdstringrequired
    authoritystringrequired
    profileIdstringrequired
    rolestringrequired
    serverIdstringrequired
- twoStepSetupRequiredboolean

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/sign-in/move/confirm" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"confirmation":"string","expectedRevision":0,"moveId":"id_8h2k4q","password":"string","username":"Fargo"}'

POST/v1/admin/sign-in/move/previewManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: post_sign_in_move_preview
Max body: 16 KiB

Request body application/json · required

Example

{
  "startOver": true,
  "to": "portico"
}

Schema

startOverbooleanrequired
tostringrequiredone of "portico", "local"

Responses

200Successapplication/json

Example

{
  "devices": 0,
  "from": "portico",
  "id": "id_8h2k4q",
  "invitations": 0,
  "ownAddressRequired": true,
  "people": 0,
  "profiles": 0,
  "removedProfiles": 0,
  "retainedProfiles": 0,
  "revision": 0,
  "serverName": "Fargo",
  "stage": "string",
  "startOver": true,
  "to": "portico",
  "waiting": 0
}

Schema

devicesinteger
fromstringrequiredone of "portico", "local"
idstringrequired
invitationsintegerrequired
ownAddressRequiredbooleanrequired
peopleintegerrequired
profilesintegerrequired
removedProfilesinteger
retainedProfilesinteger
revisionintegerrequired
serverNamestringrequired
stagestringrequired
startOverbooleanrequired
tostringrequiredone of "portico", "local"
waitingintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/sign-in/move/preview" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"startOver":true,"to":"portico"}'

GET/v1/admin/sign-in/move/waitingManage the server sign-in movesession

Audience: Clients · Native API
Authorization: Session only; API keys and personal access tokens are refused
OpenAPI operation ID: get_sign_in_move_waiting

Responses

200Successapplication/json

Example

{
  "items": [
    {
      "accountId": "id_8h2k4q",
      "expiresAt": "2026-10-18T19:30:00Z",
      "username": "Fargo"
    }
  ],
  "truncated": true
}

Schema

itemsarray of objectrequired0–2000 items
- accountIdstringrequiredlength 1–128
- expiresAtstring (date-time)length 20–35pattern ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d{1,9})?(?:Z|\+00:00)$
- usernamestringrequiredlength 1–64
truncatedbooleanrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_mismatchsign_in_kind_porticosign_in_kind_localmove_collisionmove_confirmationmove_code_invalidinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/sign-in/move/waiting" \
  -H "Authorization: Bearer $PORTICO_ACCESS_TOKEN"

GET/v1/admin/sign-in/policyRead the server sign-in policyadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: get_sign_in_policy

Responses

200Successapplication/json

Example

{
  "revision": "r12",
  "values": {
    "endedSessionsDays": 30,
    "memberResetCodeMinutes": 15,
    "passwordAttempts": "relaxed",
    "passwordMinLength": 8,
    "pinAttempts": "relaxed",
    "pinRememberDays": 0,
    "rememberAccounts": true,
    "requireTwoStep": "nobody",
    "staySignedInDays": 7
  }
}

Schema

revisionstringrequired
valuesobjectrequired
- endedSessionsDaysintegerrequiredone of 30, 90, 365
- memberResetCodeMinutesintegerrequiredone of 15, 60, 1440
- passwordAttemptsstringrequiredone of "relaxed", "standard", "strict"
- passwordMinLengthintegerrequiredone of 8, 10, 12, 16
- pinAttemptsstringrequiredone of "relaxed", "standard", "strict"
- pinRememberDaysintegerrequiredone of 0, 7, 30, 90
- rememberAccountsbooleanrequired
- requireTwoStepstringrequiredone of "nobody", "administrators", "everyone"
- staySignedInDaysintegerrequiredone of 7, 30, 90, 365

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_requiredrevision_mismatchfactor_setup_requiredinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/sign-in/policy" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

PATCH/v1/admin/sign-in/policyChange the server sign-in policyadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: patch_sign_in_policy
Max body: 4 KiB

Request body application/json · required

Example

{
  "expectedRevision": "r12",
  "values": {
    "endedSessionsDays": 30,
    "memberResetCodeMinutes": 15,
    "passwordAttempts": "relaxed",
    "passwordMinLength": 8,
    "pinAttempts": "relaxed",
    "pinRememberDays": 0,
    "rememberAccounts": true,
    "requireTwoStep": "nobody",
    "staySignedInDays": 7
  }
}

Schema

expectedRevisionstringrequired
valuesobjectrequired
- endedSessionsDaysintegerrequiredone of 30, 90, 365
- memberResetCodeMinutesintegerrequiredone of 15, 60, 1440
- passwordAttemptsstringrequiredone of "relaxed", "standard", "strict"
- passwordMinLengthintegerrequiredone of 8, 10, 12, 16
- pinAttemptsstringrequiredone of "relaxed", "standard", "strict"
- pinRememberDaysintegerrequiredone of 0, 7, 30, 90
- rememberAccountsbooleanrequired
- requireTwoStepstringrequiredone of "nobody", "administrators", "everyone"
- staySignedInDaysintegerrequiredone of 7, 30, 90, 365

Responses

200Successapplication/json

Example

{
  "revision": "r12",
  "values": {
    "endedSessionsDays": 30,
    "memberResetCodeMinutes": 15,
    "passwordAttempts": "relaxed",
    "passwordMinLength": 8,
    "pinAttempts": "relaxed",
    "pinRememberDays": 0,
    "rememberAccounts": true,
    "requireTwoStep": "nobody",
    "staySignedInDays": 7
  }
}

Schema

revisionstringrequired
valuesobjectrequired
- endedSessionsDaysintegerrequiredone of 30, 90, 365
- memberResetCodeMinutesintegerrequiredone of 15, 60, 1440
- passwordAttemptsstringrequiredone of "relaxed", "standard", "strict"
- passwordMinLengthintegerrequiredone of 8, 10, 12, 16
- pinAttemptsstringrequiredone of "relaxed", "standard", "strict"
- pinRememberDaysintegerrequiredone of 0, 7, 30, 90
- rememberAccountsbooleanrequired
- requireTwoStepstringrequiredone of "nobody", "administrators", "everyone"
- staySignedInDaysintegerrequiredone of 7, 30, 90, 365

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedrevision_requiredrevision_mismatchfactor_setup_requiredinternaldatabase_busywriter_capacity

Example request

curl -X PATCH "http://127.0.0.1:32500/v1/admin/sign-in/policy" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "expectedRevision": "r12",
  "values": {
    "endedSessionsDays": 30,
    "memberResetCodeMinutes": 15,
    "passwordAttempts": "relaxed",
    "passwordMinLength": 8,
    "pinAttempts": "relaxed",
    "pinRememberDays": 0,
    "rememberAccounts": true,
    "requireTwoStep": "nobody",
    "staySignedInDays": 7
  }
}'