Api / Users

Method	Description
🔹 list()	List users
🔹 read()	Fetch user
🔹 remove()	Remove user
🔹 updateRole()	Update roles

📚 Users API Reference

Getting started

// Place your API Key 👇 here
$sdk = new \Kronup\Sdk();

// API Call
$sdk->api()->users();

`list()`

Get a list of user models

#️⃣ Execute example in terminal

php -f list.php

Request

GET /users

Type signature

(new \Kronup\Sdk())->api()->users()->list(
    [ int $page_number = 1, ]
    [ int $page_size = 500 ]
): \Kronup\Model\UsersList

Parameters

Name	Type	Description
$page_number	int	[default to 1]
$page_size	int	[default to 500]

Return type

\Kronup\Model\UsersList

🔺 Back to top

`read()`

Retrieve user model

#️⃣ Execute example in terminal

php -f read.php

Request

GET /users/{userId}

Type signature

(new \Kronup\Sdk())->api()->users()->read(
    string $user_id
): \Kronup\Model\User

Parameters

Name	Type	Description
$user_id	string	User ID

Return type

\Kronup\Model\User

🔺 Back to top

`remove()`

Remove user from Organization

#️⃣ Execute example in terminal

php -f remove.php

Request

DELETE /users/{userId}

Type signature

(new \Kronup\Sdk())->api()->users()->remove(
    string $user_id
): \Kronup\Model\User

Parameters

Name	Type	Description
$user_id	string	User ID

Return type

\Kronup\Model\User

🔺 Back to top

`updateRole()`

Update the user model

#️⃣ Execute example in terminal

php -f updateRole.php

Request

POST /users/{userId}

Type signature

(new \Kronup\Sdk())->api()->users()->updateRole(
    string $user_id,
    \Kronup\Model\PayloadUserRoleUpdate $payload_user_role_update
): \Kronup\Model\UserRoles

Parameters

Name	Type	Description
$user_id	string	User ID
$payload_user_role_update	\Kronup\Model\PayloadUserRoleUpdate

Return type

\Kronup\Model\UserRoles

🔺 Back to top