Onboard user (community)
POST
/api/v1/auth/onboard-community
const url = 'https://example.com/api/v1/auth/onboard-community';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"country":"example","family_name":"Aspect","given_name":"Alain","organization":{"name":"example","type":"example"},"role":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/auth/onboard-community \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "country": "example", "family_name": "Aspect", "given_name": "Alain", "organization": { "name": "example", "type": "example" }, "role": "example" }'Completes the onboarding process for users accessing community services
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
country
required
string
family_name
required
string
Example
Aspectgiven_name
required
string
Example
Alainorganization
required
object
name
string
type
string
role
string
Responses
Section titled “Responses”default
Section titled “default”On success
Media typeapplication/json
object
code
required
number format: int32
data
required
object
email
string
family_name
required
string
given_name
required
string
id
required
string
message
required
string
pagination
required
object
total
required
number format: int64
status
required
string
Example
{ "code": "200", "data": { "email": "max.planck@example.com", "family_name": "Planck", "given_name": "Max" }, "message": "success", "status": "OK"}