Home
Developer documentation
Support homeSupport requestsSystem statusTrust centerTry for free

Create an account invitation

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

You can create an account invitation by calling this endpoint. An invite will be sent to the given email address to register a new account. If the given client doesn't have a login url, a bad request will be returned. If a pending invitation exists with the given email address, the response contains the existing invitation ID. If an account exists with the given email address and email mismatch is allowed in the Self-service policy, the invitation will be sent.

REQUIRED API PERMISSION
write:account
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
required
length ≥ 1

ID of the represented client

string
required
length ≥ 1
groups
array of objects
required
groups*
string
required
Defaults to en-US
metadata
object
required

Represents metadata for an account to be invited

string

ID of the represented organization. If not specified, the invited account will be non-organizational.

roles
array of objects
required
roles*
Headers
boolean
boolean
string
enum
Defaults to application/problem+json

Generated from available response content types

Allowed:
Responses

Updated 12 days 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 12 days ago