Creating a System Administrator Account

To create organizations and for other administrative workflows, adopters must create a system administrator account.

HTTP Request

Method: POST

{{url}}/user/v1/admin/create

Request Body

Payload Parameter	Data Type	Description	Required
name	String	The system administrator's name. Example: "Peter"	True
email	String	The system administrator's email ID. Example: "peter@shikshalokam.com"	True
password	String	The password for the new account. Example: "Password@123"	True
secret_code	String	Instance-specific random code set in the ENVs. Example: "W5bF7gesuS0xsNWmpsKy"	True

Request Header

Key	Value	Description	Required
internal_access_token	{{internal_access_token}}	An instance-specific, internal access token which is used for interservice network calls or communication.	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 201 Created response code. If the System Administrator user already exists, this method returns a 406 Not Acceptable response code.

Response Parameters	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.

Logging in to the System Administrator Account

After the System Administrator account is created, system administrators must log in to their account.

HTTP Request

Method: POST

{{url}}/user/v1/admin/login

Request Body

Payload Parameter	Data Type	Description	Required
email	String	The login email ID of the System Administrator account. Example: "peter@shikshalokam.com"	True
password	String	The login password of the System Administrator account. Example: "Password@123"	True

Response

If successful, this method returns a 200 OK response code. If the email or password is invalid, 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	Object	It includes the following JWTs: An access_token that is used for authentication. A refresh_token that is used for generating new access tokens.
user	Object	User's information such as ID, email, and name.
meta	Object	The formsVersion key specifies the versions of User service forms. The correlation key specifies the API request ID.