Swagger\Client\UserApi

All URIs are relative to https://atlas.forsta.io/v1

Method	HTTP request	Description
userCreate	POST /user/
userDelete	DELETE /user/{id}/
userInvite	POST /user/{id}/invite/
userList	GET /user/
userPartialUpdate	PATCH /user/{id}/
userRead	GET /user/{id}/
userUpdate	PUT /user/{id}/

userCreate

\Swagger\Client\Model\User userCreate($data)

API endpoint that allows users to be viewed or edited.

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\UserApi(
    // 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
);
$data = new \Swagger\Client\Model\User(); // \Swagger\Client\Model\User | 

try {
    $result = $apiInstance->userCreate($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
data	\Swagger\Client\Model\User

Return type

\Swagger\Client\Model\User

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

userDelete

userDelete($id)

API endpoint that allows users to be viewed or edited.

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\UserApi(
    // 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
);
$id = "id_example"; // string | A UUID string identifying this User.

try {
    $apiInstance->userDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this User.

Return type

void (empty response body)

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

userInvite

\Swagger\Client\Model\UserInviteResponse userInvite($id)

Send a mobile invite to a user.

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\UserApi(
    // 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
);
$id = "id_example"; // string | A UUID string identifying this User.

try {
    $result = $apiInstance->userInvite($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userInvite: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this User.

Return type

\Swagger\Client\Model\UserInviteResponse

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

userList

\Swagger\Client\Model\InlineResponse2005 userList($id, $email, $tags, $org__id, $user_type, $is_monitor, $created, $created__gt, $created__gte, $created__lt, $created__lte, $modified, $modified__gt, $modified__gte, $modified__lt, $modified__lte, $id_in, $phone_in, $email_in, $ordering, $search, $page, $page_size)

API endpoint that allows users to be viewed or edited.

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\UserApi(
    // 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
);
$id = "id_example"; // string | 
$email = "email_example"; // string | 
$tags = "tags_example"; // string | 
$org__id = "org__id_example"; // string | 
$user_type = "user_type_example"; // string | 
$is_monitor = "is_monitor_example"; // string | 
$created = "created_example"; // string | 
$created__gt = "created__gt_example"; // string | 
$created__gte = "created__gte_example"; // string | 
$created__lt = "created__lt_example"; // string | 
$created__lte = "created__lte_example"; // string | 
$modified = "modified_example"; // string | 
$modified__gt = "modified__gt_example"; // string | 
$modified__gte = "modified__gte_example"; // string | 
$modified__lt = "modified__lt_example"; // string | 
$modified__lte = "modified__lte_example"; // string | 
$id_in = "id_in_example"; // string | Multiple values may be separated by commas.
$phone_in = "phone_in_example"; // string | Multiple values may be separated by commas.
$email_in = "email_in_example"; // string | Multiple values may be separated by commas.
$ordering = "ordering_example"; // string | Which field to use when ordering the results.
$search = "search_example"; // string | A search term.
$page = 56; // int | A page number within the paginated result set.
$page_size = 56; // int | Number of results to return per page.

try {
    $result = $apiInstance->userList($id, $email, $tags, $org__id, $user_type, $is_monitor, $created, $created__gt, $created__gte, $created__lt, $created__lte, $modified, $modified__gt, $modified__gte, $modified__lt, $modified__lte, $id_in, $phone_in, $email_in, $ordering, $search, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string		[optional]
email	string		[optional]
tags	string		[optional]
org__id	string		[optional]
user_type	string		[optional]
is_monitor	string		[optional]
created	string		[optional]
created__gt	string		[optional]
created__gte	string		[optional]
created__lt	string		[optional]
created__lte	string		[optional]
modified	string		[optional]
modified__gt	string		[optional]
modified__gte	string		[optional]
modified__lt	string		[optional]
modified__lte	string		[optional]
id_in	string	Multiple values may be separated by commas.	[optional]
phone_in	string	Multiple values may be separated by commas.	[optional]
email_in	string	Multiple values may be separated by commas.	[optional]
ordering	string	Which field to use when ordering the results.	[optional]
search	string	A search term.	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]

Return type

\Swagger\Client\Model\InlineResponse2005

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

userPartialUpdate

\Swagger\Client\Model\User userPartialUpdate($id, $data)

API endpoint that allows users to be viewed or edited.

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\UserApi(
    // 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
);
$id = "id_example"; // string | A UUID string identifying this User.
$data = new \Swagger\Client\Model\User(); // \Swagger\Client\Model\User | 

try {
    $result = $apiInstance->userPartialUpdate($id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userPartialUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this User.
data	\Swagger\Client\Model\User

Return type

\Swagger\Client\Model\User

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

userRead

\Swagger\Client\Model\User userRead($id)

API endpoint that allows users to be viewed or edited.

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\UserApi(
    // 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
);
$id = "id_example"; // string | A UUID string identifying this User.

try {
    $result = $apiInstance->userRead($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userRead: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this User.

Return type

\Swagger\Client\Model\User

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

userUpdate

\Swagger\Client\Model\User userUpdate($id, $data)

API endpoint that allows users to be viewed or edited.

Example

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

// Configure API key authorization: JSON Web Token
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\UserApi(
    // 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
);
$id = "id_example"; // string | A UUID string identifying this User.
$data = new \Swagger\Client\Model\User(); // \Swagger\Client\Model\User | 

try {
    $result = $apiInstance->userUpdate($id, $data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UserApi->userUpdate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	A UUID string identifying this User.
data	\Swagger\Client\Model\User

Return type

\Swagger\Client\Model\User

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

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

UserApi.md

Latest commit

History

UserApi.md

File metadata and controls

Swagger\Client\UserApi

userCreate

Example

Parameters

Return type

Authorization

HTTP request headers

userDelete

Example

Parameters

Return type

Authorization

HTTP request headers

userInvite

Example

Parameters

Return type

Authorization

HTTP request headers

userList

Example

Parameters

Return type

Authorization

HTTP request headers

userPartialUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

userRead

Example

Parameters

Return type

Authorization

HTTP request headers

userUpdate

Example

Parameters

Return type

Authorization

HTTP request headers