Team Members

Create a Team Member

Changed on

Create a TeamMember using this action. It requires a JSON object containing a TeamMember.

Important

  • Organization Admin cannot be created through the API.
  • To create a Department Admin or Developer your account must be on the Connect/Growth Plan.

The access_level of each department_permissions entry determines what is created, and authorization is based on the type of API key you use:

Access LevelAccount-wide keyDepartment-specific key
Team Member (default)Any Department in the accountIts own Department only
Department AdminAny Department in the accountNot permitted
DeveloperAny Department in the accountNot permitted
Organization AdminNot permittedNot permitted

Permitted values by access_level.

<table> <thead> <tr><th>Field</th><th>Team Member</th><th colspan="2">Department Admin<sup>&ast;</sup></th><th>Developer<sup>&ast;</sup></th></tr> </thead> <tbody> <tr><td><code>access_level</code></td><td><code>team_member</code></td><td colspan="2"><code>department_admin</code></td><td><code>developer</code></td></tr> <tr><td><code>role</code></td><td><code>editor</code><br><code>credential_issuer</code><br><code>viewer</code></td><td colspan="2"><code>editor</code></td><td><code>viewer</code></td></tr> <tr><td><code>api</code></td><td>NA</td><td><code>false</code></td><td><code>true</code></td><td><code>true</code></td></tr> <tr><td><code>designs</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>emails</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>credential_attributes</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>analytics</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>settings</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>pathways</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>team</code></td><td>NA</td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>analytics_email</code></td><td>NA</td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>manage_dept_admins_and_devs</code></td><td>NA</td><td><code>true</code><br><code>false</code></td><td><code>true</code></td><td>NA</td></tr> <tr><td><code>groups</code></td><td>Array of Group IDs to limit access to</td><td colspan="2">NA (All groups allowed)</td><td>NA (All groups allowed)</td></tr> </tbody> </table>

NA - Not Applicable, can be omitted.<br><sup>*</sup> Only available on Connect/Growth Plan.

post/v1/team_members

Request

  • Base URL
    https://api.accredible.com
  • URL
    https://api.accredible.com/v1/team_members
  • Auth
    API key in header Authorization

Request body

namestring required

The name of the TeamMember user.

emailstring required

The email address of the TeamMember user.

Response

OK

Changes

    • breaking

      removed the required property /// from the response with the status

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the new optional request property ///

    • info

      added the optional property //// to the response with the status