Get one organization member
curl --request GET \
--url https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers/{uid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers/{uid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers/{uid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"uid": "user123",
"orgId": "org_ab12cd34",
"email": "member@example.com",
"username": "Member One",
"teams": [
"Team A"
],
"isAdmin": false,
"status": "Activated"
}{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "not-found",
"error_msg": "OrgUser '<uid>' not found"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Organization Members
Get one organization member
Fetch a single member’s roster entry: their email, username, teams, admin flag and invitation status within this organization.
This is the organization’s record of the member, not their personal profile. For the profile,
use GET /api/orgs/{org_id}/orgUsers/{uid}/UserProfile.
Parameters
org_id(path, required) - organization identifier.uid(path, required) - the member to read.
Response
200returns the roster entry:email,username,teams,isAdminandstatus(ActivatedorInvitation Pending). An entry whose data sharing was set throughPUT /api/orgs/{org_id}/orgUsers/{uid}?allowDataSharing=also carriesallowDataSharing.
Errors
| Status | Condition |
|---|---|
| 404 | uid is not on this organization’s roster. A uid that exists elsewhere and one that exists nowhere are answered the same way |
Authorization
- Scheme:
Authorization: Bearer <idToken>orsoxai-api-key: <api key>. - Accepted roles:
PartnerAdmin,OrgAdmin,OrgUser Adminis accepted regardless of the roles above.PartnerAdminreaches only an org owned by its own company; any other caller must carry anorgIdclaim naming exactly{org_id}.- Denials: a
PartnerAdminnaming another company’s org receives403 PartnerAdmin can change only the org that belongs to your company; a caller whoseorgIdclaim does not name{org_id}receives403 orgId not match; anyone else receives403 Not enough permission.
GET
/
api
/
orgs
/
{org_id}
/
orgUsers
/
{uid}
Get one organization member
curl --request GET \
--url https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers/{uid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers/{uid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://web-api.dev.soxai.site/api/orgs/{org_id}/orgUsers/{uid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"uid": "user123",
"orgId": "org_ab12cd34",
"email": "member@example.com",
"username": "Member One",
"teams": [
"Team A"
],
"isAdmin": false,
"status": "Activated"
}{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "not-found",
"error_msg": "OrgUser '<uid>' not found"
}{
"error": "unprocessable-entity",
"error_msg": "body.<field>: <validation message>"
}{
"error": "rate-limited",
"error_msg": "Rate limit exceeded. Retry after <n> seconds."
}{
"error": "internal-server-error",
"error_msg": "Failed to fetch data: <error_message>"
}Authorizations
HTTPBearerSoxaiApiKey
Path Parameters
Response
The roster entry. status is Activated or Invitation Pending.