Updating Organizations' Details

Organization administrators and system administrators can update an organization's details such as name and description.

Additionally, system administrators can also configure organizations that are related through an Associated policy. To learn more about the types of policies that can be configured, see Policy Architecture.

note

1. After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more.
2. Log in using {{url}}/user/v1/account/login to generate an access_token.

HTTP Request

Method: PATCH

{{url}}/user/v1/organization/update/{organization_id}

Path Parameter	Data Type	Description	Required
organization_id	Integer	Users should specify the organization ID to update the organization's details. Example: 12	True

Request Body

Payload Parameter	Data Type	Description	Required
name	String	Updated organization's name. Example: "ShikshaLokam"	False
description	String	Updated description of the organization. Example: "Empowering educational leadership."	False
related_orgs	Array of integers	Only system administrators can specify the IDs of organizations that are related through an Associated policy. Example: [3,4]	False

Request Header

Key	Value	Description	Required
X-auth-token	bearer {{access_token}}	The access_token received from the login response.	True
accept-language	{{hi}}	The response obtained will be in Hindi. If not provided, the response will be in English (default).	False

Response

If successful, this method returns a 200 OK response code. If the organization does not exist, this method returns a 400 Bad Request response.

Response Parameter	Data Type	Description
responseCode	String	A success response.
message	String	A success message.
result	Array of strings	[ ]
meta	Object	The formsVersion key specifies the versions of User service forms. The correlation key specifies the API request ID.

Deactivating Organizations

System administrators can deactivate organizations that no longer exists.

HTTP Request

Method: POST

{{url}}/user/v1/admin/deactivateOrg/{organization_id}

Path Parameter	Data Type	Description	Required
organization_id	Integer	ID of the organization that you want to deactivate. Example: 12	True

Request Body

This method does not require a request body.

Request Header

Key	Value	Description	Required
X-auth-token	bearer {{access_token}}	The access_token received from the login response.	True
accept-language	{{hi}}	The response obtained will be in Hindi. If not provided, the response will be in English (default).	False

Response

If successful, this method returns a 202 Accepted response code. If the organization is already deleted, this method returns a 400 Bad Request response.

Response Parameter	Data Type	Description
responseCode	String	A success response.
message	String	A success message.
result	Array of objects	The deactivated_users key specifies the number of users at the organization whose accounts are deactivated.
meta	Object	The formsVersion key specifies the versions of User service forms. The correlation key specifies the API request ID.

Deactivating Users

If a user leaves the organization, the organization administrator can deactivate the user's account.

note

1. After receiving the application's link through email, organization administrators must sign up on the application. See the Organization Administrator section to learn more.
2. Log in using {{url}}/user/v1/account/login to generate an access_token.

HTTP Request

Method: POST

{{url}}/user/v1/org-admin/deactivateUser

Request Body

Body Parameter	Data Type	Description	Required
id	Array of integers	ID of users whose accounts you want to deactivate. Example: [1,2]	True
email	Array of strings	Instead of user IDs, you can also specify the email IDs of users whose accounts you want to deactivate. Example: [john@shikshalokam.org, clara@shikshalokam.org]	True

Request Header

Key	Value	Description	Required
X-auth-token	bearer {{access_token}}	The access_token received from the login response.	True
accept-language	{{hi}}	The response obtained will be in Hindi. If not provided, the response will be in English (default).	False

Response

If successful, this method returns a 202 Accepted response code. If the user is already deleted, this method returns a 400 Bad Request response code.

Response Parameter	Data Type	Description
responseCode	String	A success response.
message	String	A success message.
result	Array of strings	[ ]
meta	Object	The formsVersion key specifies the versions of User service forms. The correlation key specifies the API request ID.