People and groups
Onboard the caller
Onboard the caller
curl --request POST \
--url https://api.atlan.com/registry/v1/users/onboard \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atlan.com/registry/v1/users/onboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlan.com/registry/v1/users/onboard"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"groups": [
{
"created_at": "<string>",
"id": "<string>",
"updated_at": "<string>",
"external_id": "<string>",
"name": "<string>"
}
],
"is_created": true,
"org": {
"created_at": "<string>",
"created_by": "<string>",
"display_name": "<string>",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"org_wide": true,
"root_workspace_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"visibility": "<string>",
"workspace_status": "<string>",
"artifact_count": 1,
"artifact_count_by_kind": {},
"member_count": 1,
"parent_id": "<string>",
"permissions": {}
},
"org_seat": "<string>",
"organisation": {
"created_at": "<string>",
"id": "<string>",
"updated_at": "<string>",
"name": "<string>"
},
"user": {
"created_at": "<string>",
"id": "<string>",
"updated_at": "<string>",
"email": "<string>",
"enrichment": "<unknown>",
"name": "<string>"
},
"user_default": {
"created_at": "<string>",
"created_by": "<string>",
"display_name": "<string>",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"org_wide": true,
"root_workspace_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"visibility": "<string>",
"workspace_status": "<string>",
"artifact_count": 1,
"artifact_count_by_kind": {},
"member_count": 1,
"parent_id": "<string>",
"permissions": {}
}
}{
"code": "alg_mismatch",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "access_denied",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "conflict",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "validation_failed",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "internal_error",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "auth_unavailable",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "request_timeout",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
⌘I
Onboard the caller
curl --request POST \
--url https://api.atlan.com/registry/v1/users/onboard \
--header 'Authorization: Bearer <token>'const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.atlan.com/registry/v1/users/onboard', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlan.com/registry/v1/users/onboard"
headers = {"Authorization": "Bearer <token>"}
response = requests.post(url, headers=headers)
print(response.text){
"groups": [
{
"created_at": "<string>",
"id": "<string>",
"updated_at": "<string>",
"external_id": "<string>",
"name": "<string>"
}
],
"is_created": true,
"org": {
"created_at": "<string>",
"created_by": "<string>",
"display_name": "<string>",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"org_wide": true,
"root_workspace_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"visibility": "<string>",
"workspace_status": "<string>",
"artifact_count": 1,
"artifact_count_by_kind": {},
"member_count": 1,
"parent_id": "<string>",
"permissions": {}
},
"org_seat": "<string>",
"organisation": {
"created_at": "<string>",
"id": "<string>",
"updated_at": "<string>",
"name": "<string>"
},
"user": {
"created_at": "<string>",
"id": "<string>",
"updated_at": "<string>",
"email": "<string>",
"enrichment": "<unknown>",
"name": "<string>"
},
"user_default": {
"created_at": "<string>",
"created_by": "<string>",
"display_name": "<string>",
"id": "<string>",
"kind": "<string>",
"name": "<string>",
"org_wide": true,
"root_workspace_id": "<string>",
"updated_at": "<string>",
"updated_by": "<string>",
"visibility": "<string>",
"workspace_status": "<string>",
"artifact_count": 1,
"artifact_count_by_kind": {},
"member_count": 1,
"parent_id": "<string>",
"permissions": {}
}
}{
"code": "alg_mismatch",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "access_denied",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "conflict",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "validation_failed",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "internal_error",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "auth_unavailable",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}{
"code": "request_timeout",
"detail": "<string>",
"status": 1,
"title": "<string>",
"trace_id": "<string>"
}