Organization Admin

Collect metrics

get
/clients/v1/organization-admin/dashboard/collect-metrics

Collects dashboard metrics. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_5f9b3c4d-e8a1-4b2f-9e7d-12a34b56c789
Client-SecretstringRequiredExample: sk_x7k9p2m4q8r5t1y3w6u0v9z2b4c6n8m
Responses
chevron-right
200

Metrics collected successfully.

No content

get
/clients/v1/organization-admin/dashboard/collect-metrics

No content

Update user limit

put
/clients/v1/organization-admin/users/{user}/limits/update

Updates the storage limit for a specific user. Requires authentication.

Path parameters
userstringRequired

The ID of the user whose limit is to be updated.

Example: 686ea73481fbe273d180e8fe
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
bytes_limitintegerRequired

The new storage limit in bytes.

Example: 5368709120
Responses
chevron-right
200

Limit updated successfully.

No content

put
/clients/v1/organization-admin/users/{user}/limits/update

No content

List members

get
/clients/v1/organization-admin/members/list

Retrieves a list of all members with pagination. Requires authentication.

Query parameters
pageintegerOptional

Page number for pagination.

Example: 1
limitintegerOptional

Maximum number of members per page.

Example: 10
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
chevron-right
200

List of members retrieved successfully.

No content

get
/clients/v1/organization-admin/members/list

No content

Create member

post
/clients/v1/organization-admin/members/create

Creates a new member. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
first_namestringRequired

The first name of the member.

Example: JB
middle_namestring · nullableOptional

The middle name of the member (optional).

last_namestringRequired

The last name of the member.

Example: Benedicto
suffixstring · nullableOptional

The suffix of the member (e.g., Jr., Sr.) (optional).

emailstringRequired

Member email address.

Example: jb+8@ardata.tech
passwordstringRequired

Member password (must meet complexity requirements).

Example: StrongPass123!
confirm_passwordstringRequired

Confirmation of the member password.

Example: StrongPass123!
rolestringRequired

Member role (e.g., organization_user).

Example: organization_user
Responses
post
/clients/v1/organization-admin/members/create

No content

Read member

get
/clients/v1/organization-admin/members/{user}/read

Retrieves details of a specific member. Requires authentication.

Path parameters
userstringRequired

The ID of the member to retrieve.

Example: 686ea73481fbe273d180e8fe
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
chevron-right
200

Member details retrieved successfully.

No content

get
/clients/v1/organization-admin/members/{user}/read

No content

get
/clients/v1/organization-admin/members/search

Searches for members by email. Requires authentication.

Query parameters
emailstringRequired

Search term for member email.

Example: jb+7@ardata.tech
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
chevron-right
200

Members found successfully.

No content

get
/clients/v1/organization-admin/members/search

No content

Update member

put
/clients/v1/organization-admin/members/{user}/update

Updates details of a specific member. Requires authentication.

Path parameters
userstringRequired

The ID of the member to update.

Example: 6873e39d485ac74c10176138
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
first_namestringOptional

Updated first name of the member.

Example: Alexander Paul
middle_namestring · nullableOptional

Updated middle name of the member (optional).

Example: Puno
last_namestringOptional

Updated last name of the member.

Example: Quinit
suffixstring · nullableOptional

Updated suffix of the member (e.g., Jr., Sr.) (optional).

emailstringOptional

Updated member email address.

Example: jb+3@ardata.tech
passwordstringOptional

Updated member password (must meet complexity requirements, optional).

Example: StrongPass123!
is_verifiedbooleanOptional

Updated verification status of the member.

Example: true
is_lockedbooleanOptional

Updated lock status of the member.

Example: false
is_deletedbooleanOptional

Updated deleted status of the member.

Example: false
Responses
chevron-right
200

Member updated successfully.

No content

put
/clients/v1/organization-admin/members/{user}/update

No content

Remove member

delete
/clients/v1/organization-admin/members/{userID}/remove

Removes a member from an organization. Requires authentication.

Path parameters
userIDstringRequired

The ID of the member to remove.

Example: 686ed041e558da075c6d8e87
Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
chevron-right
200

Member removed successfully.

No content

delete
/clients/v1/organization-admin/members/{userID}/remove

No content

Read organization

get
/clients/v1/organization-admin/organization/read

Retrieves details of the organization. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Responses
chevron-right
200

Organization details retrieved successfully.

No content

get
/clients/v1/organization-admin/organization/read

No content

Update organization

put
/clients/v1/organization-admin/organization/update

Updates details of the organization. Requires authentication.

Header parameters
Client-IDstringRequiredExample: id_UGacp3OrGbGt78bpwzmhkB42cfhTL0US2dPMTbVb1E
Client-SecretstringRequiredExample: sk_1e9KhX0ZReeT6Avugl8cA2rBvKdD2z05LB9VrA4q3hY
Body
namestringOptional

Updated name of the organization.

Example: AR Data Technologies
domainstringOptional

Updated domain associated with the organization.

Example: ardata.tech
contactstringOptional

Updated contact email for the organization.

Example: jb@ardata.tech
parent_idstring · nullableOptional

Updated ID of the parent organization (optional).

Responses
chevron-right
200

Organization updated successfully.

No content

put
/clients/v1/organization-admin/organization/update

No content

Last updated