Page tree
Skip to end of metadata
Go to start of metadata

Request: GET /user/{user_id}

Permissions to Run the Request

Account Owner, Account Administrators, Department Administrators, or custom roles

Department Administrators and users with a custom role can get information about users belonging only to the departments they manage and their sub-departments.

Request Headers

ParameterDescription
X-Auth-Account-Url (required)The base URL of the account, e.g. http://myaccount.ispringlearn.com
X-Auth-Email (required)The login of Account Owner, Account Administrator, Department Administrator, or a user with a custom role
X-Auth-Password (required)The password of Account Owner, Account AdministratorDepartment Administrator, or a user with a custom role

Possible Response Codes

CodeTextDescription
200Successful operation

The request was successfully processed. The body of the response will contain xml data with user info.

400Bad RequestA request error.
401UnauthorizedAn authorization error.
403Permission Denied

The user doesn't have enough permissions to complete the request.

Sample Request

GET /user/f29d887c-5cff-11e9-9e6a-0a580af40692 HTTP/1.1
Host: api-learn.ispringlearn.com
X-Auth-Account-Url: https://myaccount.ispringlearn.com
X-Auth-Email: email@email.com
X-Auth-Password: password

Sample Response

HTTP/1.1 200 Successful operation
Connection: close

<?xml version="1.0" encoding="UTF-8"?>
<response>
	<userProfile>
		<userId>string</userId>
		<role>string</role>
		<departmentId>3fa85f64-5717-4562-b3fc-2c963f66afa6</departmentId>
		<status>1</status>
		<fields>
          <field>
            <name>LOGIN</name>
            <value>helen@ispringsolutions.com</value>
          </field>
          <field>
            <name>EMAIL</name>
            <value>helen@ispringsolutions.com</value>
          </field>
          <field>
            <name>FIRST_NAME</name>
            <value>Helen</value>
          </field>
          <field>
            <name>LAST_NAME</name>
            <value>Smith</value>
          </field>
          <field>
            <name>JOB_TITLE</name>
            <value>Sales Manager</value>
          </field>
          <field>
            <name>COUNTRY</name>
            <value>643</value>
          </field>
        </fields>
		<groups>
			<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
		</groups>
		<manageableDepartmentIds>
			<id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
		</manageableDepartmentIds>
		<addedDate>2019-04-30</addedDate>
		<lastLoginDate>2019-04-30</lastLoginDate>
	</userProfile>
</response>
  • No labels