Contents x
    Schemas
    • 29 Apr 2024
    • 1 Minute to read
    • Contributors
      Contents

      Schemas

      • Updated on 29 Apr 2024
      • 1 Minute to read
      • Contributors
        Article Summary

        Request Headers

        Each request must include the following request headers:

        PropertyData TypeDescription
        Authorization*StringYour temporary Access Token obtained using the /authorize method
        Content-Type*
        		String
        		application/json

        Request Body Schemas

        User

        A user, also known as a Member. Response to POST /v1/users and DELETE /v1/users/{id}. Found in UserList.

        PropertyData TypeDescription
        terminated*BooleanWhether user is deleted (true).
        email*String ($UTF8)User email.
        emailVerified*BooleanWhether email is verified (true).
        initials*StringUser initials.
        roleName*StringUser role.
        lastName*StringUser last name.
        firstname*StringUser first name.
        id*StringID of user.

        UserList

        List of users. Response to GET /v1/users.

        PropertyData TypeDescription
        data*Array of UserList of users.
        page*NumberStarting page number.
        totalPage*NumberNumber of pages in list.
        itemsTotal*NumberNumber of items in list.

        CreateUserDto

        DTO for creating a new member. Request body to /v1/users.

        Property

        Data Type

        Description

        idpType

        String

        Type of identity provider. 

        For users created via the API, the value will always be "database"

        Below you can find the available values.

        accessGroups

        Array of String

        List of Access Group names to which the new user should be assigned.

        email*

        String ($UTF8)

        User’s email address.

        emailVerified

        Boolean

        Whether the email is already verified ("true").

        inviteMessage*

        String

        The message that will be attached to the invitation email sent to the new user.

        profileData

        ProfileSchema

        Profile information:

        • firstName
        • lastName
        • roleName
        • phone
        • icon

        origin

        String ($UTF8)

        Source. Minimum length of 1.

        ProfileSchema

        Member profile information. Found in CreateUserDto.

        PropertyData TypeDescription
        firstNameStringFirst name of user.
        lastNameStringLast name of user.
        roleNameStringName of user's role.
        phoneStringTelephone.
        iconStringUser's icon, if any.

        idpType

        Type of the identity provider. Found in CreateUserDto.

        ValueDescription
        databaseDatabase-based authentication.
        samlSecurity Assertion Markup Language standard for authentication and authorization.
        gsuiteGoogle Workspace cloud tool.
        oktaOkta identity and access management.
        azureADMicrosoft Entra ID (formerly Azure Active Directory) authentication.
        adLdapPHP class that provides LDAP authentication and integration with Active Directory.
        Was this article helpful?
        What's Next