Skip to content
Navigation

Register with email/password

Register a new user and return tokens.

When tenant_id is provided the user is scoped to that tenant and can only authenticate within it. When omitted the user is created as a platform-wide user who can access any tenant/app.

POST
https://truememory-auth.mvstg.com/auth/register
View as Markdown

Request bodyJSONrequired

  • emailstringrequired
    format: email
  • passwordstringrequired
    minLength: 6
  • display_nameoptional

    One of the following:

    • string
    • null
  • tenant_idoptional

    Google Identity Platform tenant ID. When set, the user is scoped to this tenant and can only authenticate within it. When omitted, the user is platform-wide and can access any app. Contact your admin to obtain a tenant ID for tenant-scoped registration.

    One of the following:

    • string
    • null
  • metadataoptional

    Arbitrary key/value profile data stored with the user account. Max 50 keys, 16 KB.

    One of the following:

    • object
    • null
  • app_nameoptional

    One of the following:

    • string
    • null

Returns

201

Successful Response

JSON
  • id_tokenstringrequired
  • refresh_tokenstringrequired
  • expires_instringrequired
  • useroptional

    One of the following:

    • AuthUser
      • idstringrequired
        format: uuid
      • gip_uidstringrequired
      • tenant_idoptional

        One of the following:

        • string
        • null
      • emailoptional

        One of the following:

        • string
        • null
      • email_verifiedoptionalboolean
        default: false
      • usernameoptional

        One of the following:

        • string
        • null
      • display_nameoptional

        One of the following:

        • string
        • null
      • photo_urloptional

        One of the following:

        • string
        • null
      • phone_numberoptional

        One of the following:

        • string
        • null
      • disabledoptionalboolean
        default: false
      • roleoptionalstring
        default: "user"
      • metadataoptionalobject
      • raw_app_meta_dataoptionalobject
      • custom_claimsoptionalobject
      • last_sign_in_atoptional

        One of the following:

        • string
        • null
      • created_atoptional

        One of the following:

        • string
        • null
      • updated_atoptional

        One of the following:

        • string
        • null
      • deleted_atoptional

        One of the following:

        • string
        • null
      • deletion_completed_atoptional

        One of the following:

        • string
        • null
    • null

422

Validation Error
JSON
  • detailoptionalarray ofobject
    • locarray ofrequired

      One of the following:

      • string
      • integer
    • msgstringrequired
    • typestringrequired
    • inputoptionalunknown
    • ctxoptionalobject

Type to search…

↑↓ navigate↵ selectEsc close