OpenAPI\Client\UsersApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
assignRoleToUser()	POST /v2/facts/{proj_id}/{env_id}/users/{user_id}/roles	Assign Role To User
createUser()	POST /v2/facts/{proj_id}/{env_id}/users	Create User
deleteUser()	DELETE /v2/facts/{proj_id}/{env_id}/users/{user_id}	Delete User
getUser()	GET /v2/facts/{proj_id}/{env_id}/users/{user_id}	Get User
listUsers()	GET /v2/facts/{proj_id}/{env_id}/users	List Users
replaceUser()	PUT /v2/facts/{proj_id}/{env_id}/users/{user_id}	Replace User
unassignRoleFromUser()	DELETE /v2/facts/{proj_id}/{env_id}/users/{user_id}/roles	Unassign Role From User
updateUser()	PATCH /v2/facts/{proj_id}/{env_id}/users/{user_id}	Update User

`assignRoleToUser()`

assignRoleToUser($proj_id, $env_id, $user_id, $user_role_create): \OpenAPI\Client\Model\RoleAssignmentRead

Assign Role To User

Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$user_id = 'user_id_example'; // string | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
$user_role_create = new \OpenAPI\Client\Model\UserRoleCreate(); // \OpenAPI\Client\Model\UserRoleCreate

try {
    $result = $apiInstance->assignRoleToUser($proj_id, $env_id, $user_id, $user_role_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->assignRoleToUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
user_id	string	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
user_role_create	\OpenAPI\Client\Model\UserRoleCreate

Return type

\OpenAPI\Client\Model\RoleAssignmentRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createUser()`

createUser($proj_id, $env_id, $user_create): \OpenAPI\Client\Model\UserRead

Create User

Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$user_create = new \OpenAPI\Client\Model\UserCreate(); // \OpenAPI\Client\Model\UserCreate

try {
    $result = $apiInstance->createUser($proj_id, $env_id, $user_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->createUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
user_create	\OpenAPI\Client\Model\UserCreate

Return type

\OpenAPI\Client\Model\UserRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteUser()`

deleteUser($proj_id, $env_id, $user_id)

Delete User

Deletes the user and all its related data.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$user_id = 'user_id_example'; // string | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").

try {
    $apiInstance->deleteUser($proj_id, $env_id, $user_id);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->deleteUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
user_id	string	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

Return type

void (empty response body)

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`getUser()`

getUser($proj_id, $env_id, $user_id): \OpenAPI\Client\Model\UserRead

Get User

Gets a user, if such user exists. Otherwise returns 404.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$user_id = 'user_id_example'; // string | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").

try {
    $result = $apiInstance->getUser($proj_id, $env_id, $user_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
user_id	string	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

Return type

\OpenAPI\Client\Model\UserRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listUsers()`

listUsers($proj_id, $env_id, $search, $page, $per_page): \OpenAPI\Client\Model\PaginatedResultUserRead

List Users

Lists all the users defined within an environment.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$search = 'search_example'; // string | Text search for the email field
$page = 1; // int | Page number of the results to fetch, starting at 1.
$per_page = 30; // int | The number of results per page (max 100).

try {
    $result = $apiInstance->listUsers($proj_id, $env_id, $search, $page, $per_page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->listUsers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
search	string	Text search for the email field	[optional]
page	int	Page number of the results to fetch, starting at 1.	[optional] [default to 1]
per_page	int	The number of results per page (max 100).	[optional] [default to 30]

Return type

\OpenAPI\Client\Model\PaginatedResultUserRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`replaceUser()`

replaceUser($proj_id, $env_id, $user_id, $user_create): \OpenAPI\Client\Model\UserRead

Replace User

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$user_id = 'user_id_example'; // string | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
$user_create = new \OpenAPI\Client\Model\UserCreate(); // \OpenAPI\Client\Model\UserCreate

try {
    $result = $apiInstance->replaceUser($proj_id, $env_id, $user_id, $user_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->replaceUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
user_id	string	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
user_create	\OpenAPI\Client\Model\UserCreate

Return type

\OpenAPI\Client\Model\UserRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`unassignRoleFromUser()`

unassignRoleFromUser($proj_id, $env_id, $user_id, $user_role_remove): \OpenAPI\Client\Model\UserRead

Unassign Role From User

Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$user_id = 'user_id_example'; // string | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
$user_role_remove = new \OpenAPI\Client\Model\UserRoleRemove(); // \OpenAPI\Client\Model\UserRoleRemove

try {
    $result = $apiInstance->unassignRoleFromUser($proj_id, $env_id, $user_id, $user_role_remove);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->unassignRoleFromUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
user_id	string	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
user_role_remove	\OpenAPI\Client\Model\UserRoleRemove

Return type

\OpenAPI\Client\Model\UserRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateUser()`

updateUser($proj_id, $env_id, $user_id, $user_update): \OpenAPI\Client\Model\UserRead

Update User

Partially updates the user definition. Fields that will be provided will be completely overwritten.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: HTTPBearer
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\UsersApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$proj_id = 'proj_id_example'; // string | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
$env_id = 'env_id_example'; // string | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
$user_id = 'user_id_example'; // string | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
$user_update = new \OpenAPI\Client\Model\UserUpdate(); // \OpenAPI\Client\Model\UserUpdate

try {
    $result = $apiInstance->updateUser($proj_id, $env_id, $user_id, $user_update);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->updateUser: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
proj_id	string	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
env_id	string	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
user_id	string	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
user_update	\OpenAPI\Client\Model\UserUpdate

Return type

\OpenAPI\Client\Model\UserRead

Authorization

HTTPBearer

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

OpenAPI\Client\UsersApi

assignRoleToUser()

Example

Parameters

Return type

Authorization

HTTP request headers

createUser()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteUser()

Example

Parameters

Return type

Authorization

HTTP request headers

getUser()

Example

Parameters

Return type

Authorization

HTTP request headers

listUsers()

Example

Parameters

Return type

Authorization

HTTP request headers

replaceUser()

Example

Parameters

Return type

Authorization

HTTP request headers

unassignRoleFromUser()

Example

Parameters

Return type

Authorization

HTTP request headers

updateUser()

Example

Parameters

Return type

Authorization

HTTP request headers

`assignRoleToUser()`

`createUser()`

`deleteUser()`

`getUser()`

`listUsers()`

`replaceUser()`

`unassignRoleFromUser()`

`updateUser()`