Home
Developer documentation
Support homeSupport requestsSystem statusTrust centerTry for free

Create an admin account invitation

post
https://{tenant}/admin/api/v1/admin/identityStore/invite

You can create an admin account invitation by calling this endpoint. An invite will be sent to the given email address to register a new admin account. If a pending invitation exists with the given email address, the response contains the existing invitation ID. If an admin account exists with the given email address, the invitation will not be sent, because email mismatch is not allowed for admin invites.

REQUIRED API PERMISSION
write:admin_account
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
metadata
object
required

Represents metadata for an admin account to be invited

roles
array of objects
required

Represents the role IDs for an admin account to be invited

roles*
Headers
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
*/*
application/problem+json

Updated 4 months ago