Swagger\Client\RoleApi

All URIs are relative to https://localhost:20000/api/3.1

Method	HTTP request	Description
allModelSets	GET /model_sets	Get All Model Sets
allPermissionSets	GET /permission_sets	Get All Permission Sets
allPermissions	GET /permissions	Get All Permissions
allRoles	GET /roles	Get All Roles
createModelSet	POST /model_sets	Create Model Set
createPermissionSet	POST /permission_sets	Create Permission Set
createRole	POST /roles	Create Role
deleteModelSet	DELETE /model_sets/{model_set_id}	Delete Model Set
deletePermissionSet	DELETE /permission_sets/{permission_set_id}	Delete Permission Set
deleteRole	DELETE /roles/{role_id}	Delete Role
modelSet	GET /model_sets/{model_set_id}	Get Model Set
permissionSet	GET /permission_sets/{permission_set_id}	Get Permission Set
role	GET /roles/{role_id}	Get Role
roleGroups	GET /roles/{role_id}/groups	Get Role Groups
roleUsers	GET /roles/{role_id}/users	Get Role Users
searchModelSets	GET /model_sets/search	Search Model Sets
searchPermissionSets	GET /permission_sets/search	Search Permission Sets
searchRoles	GET /roles/search	Search Roles
searchRolesWithUserCount	GET /roles/search/with_user_count	Search Roles with User Count
setRoleGroups	PUT /roles/{role_id}/groups	Update Role Groups
setRoleUsers	PUT /roles/{role_id}/users	Update Role Users
updateModelSet	PATCH /model_sets/{model_set_id}	Update Model Set
updatePermissionSet	PATCH /permission_sets/{permission_set_id}	Update Permission Set
updateRole	PATCH /roles/{role_id}	Update Role

allModelSets

\Swagger\Client\Model\ModelSet[] allModelSets($fields)

Get All Model Sets

Get information about all model sets.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ModelSet[]

Authorization

No authorization required

HTTP request headers

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

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

allPermissionSets

\Swagger\Client\Model\PermissionSet[] allPermissionSets($fields)

Get All Permission Sets

Get information about all permission sets.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.

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

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\PermissionSet[]

Authorization

No authorization required

HTTP request headers

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

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

allPermissions

\Swagger\Client\Model\Permission[] allPermissions()

Get All Permissions

Get all supported permissions.

Example

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

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

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

Parameters

This endpoint does not need any parameter.

Return type

\Swagger\Client\Model\Permission[]

Authorization

No authorization required

HTTP request headers

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

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

allRoles

\Swagger\Client\Model\Role[] allRoles($fields, $ids)

Get All Roles

Get information about all roles.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.
$ids = array("ids_example"); // string[] | Optional list of ids to get specific roles.

try {
    $result = $apiInstance->allRoles($fields, $ids);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->allRoles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
ids	string[]	Optional list of ids to get specific roles.	[optional]

Return type

\Swagger\Client\Model\Role[]

Authorization

No authorization required

HTTP request headers

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

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

createModelSet

\Swagger\Client\Model\ModelSet createModelSet($body)

Create Model Set

Create a model set with the specified information. Model sets are used by Roles.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$body = new \Swagger\Client\Model\ModelSet(); // \Swagger\Client\Model\ModelSet | ModelSet

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\ModelSet	ModelSet

Return type

\Swagger\Client\Model\ModelSet

Authorization

No authorization required

HTTP request headers

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

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

createPermissionSet

\Swagger\Client\Model\PermissionSet createPermissionSet($body)

Create Permission Set

Create a permission set with the specified information. Permission sets are used by Roles.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$body = new \Swagger\Client\Model\PermissionSet(); // \Swagger\Client\Model\PermissionSet | Permission Set

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\PermissionSet	Permission Set

Return type

\Swagger\Client\Model\PermissionSet

Authorization

No authorization required

HTTP request headers

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

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

createRole

\Swagger\Client\Model\Role createRole($body)

Create Role

Create a role with the specified information.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$body = new \Swagger\Client\Model\Role(); // \Swagger\Client\Model\Role | Role

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

Parameters

Name	Type	Description	Notes
body	\Swagger\Client\Model\Role	Role

Return type

\Swagger\Client\Model\Role

Authorization

No authorization required

HTTP request headers

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

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

deleteModelSet

string deleteModelSet($model_set_id)

Delete Model Set

Delete the model set with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$model_set_id = "model_set_id_example"; // string | id of model set

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

Parameters

Name	Type	Description	Notes
model_set_id	string	id of model set

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

deletePermissionSet

string deletePermissionSet($permission_set_id)

Delete Permission Set

Delete the permission set with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$permission_set_id = "permission_set_id_example"; // string | Id of permission set

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

Parameters

Name	Type	Description	Notes
permission_set_id	string	Id of permission set

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

deleteRole

string deleteRole($role_id)

Delete Role

Delete the role with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$role_id = "role_id_example"; // string | id of role

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

Parameters

Name	Type	Description	Notes
role_id	string	id of role

Return type

string

Authorization

No authorization required

HTTP request headers

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

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

modelSet

\Swagger\Client\Model\ModelSet modelSet($model_set_id, $fields)

Get Model Set

Get information about the model set with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$model_set_id = "model_set_id_example"; // string | Id of model set
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->modelSet($model_set_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->modelSet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
model_set_id	string	Id of model set
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\ModelSet

Authorization

No authorization required

HTTP request headers

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

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

permissionSet

\Swagger\Client\Model\PermissionSet permissionSet($permission_set_id, $fields)

Get Permission Set

Get information about the permission set with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$permission_set_id = "permission_set_id_example"; // string | Id of permission set
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->permissionSet($permission_set_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->permissionSet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
permission_set_id	string	Id of permission set
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\PermissionSet

Authorization

No authorization required

HTTP request headers

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

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

role

\Swagger\Client\Model\Role role($role_id)

Get Role

Get information about the role with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$role_id = "role_id_example"; // string | id of role

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

Parameters

Name	Type	Description	Notes
role_id	string	id of role

Return type

\Swagger\Client\Model\Role

Authorization

No authorization required

HTTP request headers

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

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

roleGroups

\Swagger\Client\Model\Group[] roleGroups($role_id, $fields)

Get Role Groups

Get information about all the groups with the role that has a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$role_id = "role_id_example"; // string | id of role
$fields = "fields_example"; // string | Requested fields.

try {
    $result = $apiInstance->roleGroups($role_id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->roleGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
role_id	string	id of role
fields	string	Requested fields.	[optional]

Return type

\Swagger\Client\Model\Group[]

Authorization

No authorization required

HTTP request headers

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

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

roleUsers

\Swagger\Client\Model\User[] roleUsers($role_id, $fields, $direct_association_only)

Get Role Users

Get information about all the users with the role that has a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$role_id = "role_id_example"; // string | id of role
$fields = "fields_example"; // string | Requested fields.
$direct_association_only = true; // bool | Get only users associated directly with the role: exclude those only associated through groups.

try {
    $result = $apiInstance->roleUsers($role_id, $fields, $direct_association_only);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->roleUsers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
role_id	string	id of role
fields	string	Requested fields.	[optional]
direct_association_only	bool	Get only users associated directly with the role: exclude those only associated through groups.	[optional]

Return type

\Swagger\Client\Model\User[]

Authorization

No authorization required

HTTP request headers

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

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

searchModelSets

\Swagger\Client\Model\ModelSet[] searchModelSets($fields, $limit, $offset, $sorts, $id, $name, $all_access, $built_in, $filter_or)

Search Model Sets

Search model sets Returns all model set records that match the given search criteria. If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.
$limit = 789; // int | Number of results to return (used with `offset`).
$offset = 789; // int | Number of results to skip before returning any (used with `limit`).
$sorts = "sorts_example"; // string | Fields to sort by.
$id = "id_example"; // string | Match model set id.
$name = "name_example"; // string | Match model set name.
$all_access = true; // bool | Match model sets by all_access status.
$built_in = true; // bool | Match model sets by built_in status.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression.

try {
    $result = $apiInstance->searchModelSets($fields, $limit, $offset, $sorts, $id, $name, $all_access, $built_in, $filter_or);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->searchModelSets: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
limit	int	Number of results to return (used with `offset`).	[optional]
offset	int	Number of results to skip before returning any (used with `limit`).	[optional]
sorts	string	Fields to sort by.	[optional]
id	string	Match model set id.	[optional]
name	string	Match model set name.	[optional]
all_access	bool	Match model sets by all_access status.	[optional]
built_in	bool	Match model sets by built_in status.	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression.	[optional]

Return type

\Swagger\Client\Model\ModelSet[]

Authorization

No authorization required

HTTP request headers

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

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

searchPermissionSets

\Swagger\Client\Model\PermissionSet[] searchPermissionSets($fields, $limit, $offset, $sorts, $id, $name, $all_access, $built_in, $filter_or)

Search Permission Sets

Search permission sets Returns all permission set records that match the given search criteria. If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.
$limit = 789; // int | Number of results to return (used with `offset`).
$offset = 789; // int | Number of results to skip before returning any (used with `limit`).
$sorts = "sorts_example"; // string | Fields to sort by.
$id = "id_example"; // string | Match permission set id.
$name = "name_example"; // string | Match permission set name.
$all_access = true; // bool | Match permission sets by all_access status.
$built_in = true; // bool | Match permission sets by built_in status.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression.

try {
    $result = $apiInstance->searchPermissionSets($fields, $limit, $offset, $sorts, $id, $name, $all_access, $built_in, $filter_or);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->searchPermissionSets: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
limit	int	Number of results to return (used with `offset`).	[optional]
offset	int	Number of results to skip before returning any (used with `limit`).	[optional]
sorts	string	Fields to sort by.	[optional]
id	string	Match permission set id.	[optional]
name	string	Match permission set name.	[optional]
all_access	bool	Match permission sets by all_access status.	[optional]
built_in	bool	Match permission sets by built_in status.	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression.	[optional]

Return type

\Swagger\Client\Model\PermissionSet[]

Authorization

No authorization required

HTTP request headers

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

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

searchRoles

\Swagger\Client\Model\Role[] searchRoles($fields, $limit, $offset, $sorts, $id, $name, $built_in, $filter_or)

Search Roles

Search roles Returns all role records that match the given search criteria. If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.
$limit = 789; // int | Number of results to return (used with `offset`).
$offset = 789; // int | Number of results to skip before returning any (used with `limit`).
$sorts = "sorts_example"; // string | Fields to sort by.
$id = "id_example"; // string | Match role id.
$name = "name_example"; // string | Match role name.
$built_in = true; // bool | Match roles by built_in status.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression.

try {
    $result = $apiInstance->searchRoles($fields, $limit, $offset, $sorts, $id, $name, $built_in, $filter_or);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->searchRoles: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
limit	int	Number of results to return (used with `offset`).	[optional]
offset	int	Number of results to skip before returning any (used with `limit`).	[optional]
sorts	string	Fields to sort by.	[optional]
id	string	Match role id.	[optional]
name	string	Match role name.	[optional]
built_in	bool	Match roles by built_in status.	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression.	[optional]

Return type

\Swagger\Client\Model\Role[]

Authorization

No authorization required

HTTP request headers

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

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

searchRolesWithUserCount

\Swagger\Client\Model\RoleSearch[] searchRolesWithUserCount($fields, $limit, $offset, $sorts, $id, $name, $built_in, $filter_or)

Search Roles with User Count

Search roles include user count Returns all role records that match the given search criteria, and attaches associated user counts. If multiple search params are given and `filter_or` is FALSE or not specified, search params are combined in a logical AND operation. Only rows that match all search param criteria will be returned. If `filter_or` is TRUE, multiple search params are combined in a logical OR operation. Results will include rows that match any of the search criteria. String search params use case-insensitive matching. String search params can contain `%` and '_' as SQL LIKE pattern match wildcard expressions. example="dan%" will match "danger" and "Danzig" but not "David" example="D_m%" will match "Damage" and "dump" Integer search params can accept a single value or a comma separated list of values. The multiple values will be combined under a logical OR operation - results will match at least one of the given values. Most search params can accept "IS NULL" and "NOT NULL" as special expressions to match or exclude (respectively) rows where the column is null. Boolean search params accept only "true" and "false" as values.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$fields = "fields_example"; // string | Requested fields.
$limit = 789; // int | Number of results to return (used with `offset`).
$offset = 789; // int | Number of results to skip before returning any (used with `limit`).
$sorts = "sorts_example"; // string | Fields to sort by.
$id = "id_example"; // string | Match role id.
$name = "name_example"; // string | Match role name.
$built_in = true; // bool | Match roles by built_in status.
$filter_or = true; // bool | Combine given search criteria in a boolean OR expression.

try {
    $result = $apiInstance->searchRolesWithUserCount($fields, $limit, $offset, $sorts, $id, $name, $built_in, $filter_or);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->searchRolesWithUserCount: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
fields	string	Requested fields.	[optional]
limit	int	Number of results to return (used with `offset`).	[optional]
offset	int	Number of results to skip before returning any (used with `limit`).	[optional]
sorts	string	Fields to sort by.	[optional]
id	string	Match role id.	[optional]
name	string	Match role name.	[optional]
built_in	bool	Match roles by built_in status.	[optional]
filter_or	bool	Combine given search criteria in a boolean OR expression.	[optional]

Return type

\Swagger\Client\Model\RoleSearch[]

Authorization

No authorization required

HTTP request headers

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

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

setRoleGroups

\Swagger\Client\Model\Group[] setRoleGroups($role_id, $body)

Update Role Groups

Set all groups for a role, removing all existing group associations from that role.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$role_id = "role_id_example"; // string | id of role
$body = array(new \Swagger\Client\Model\string[]()); // string[] | Array of Group Ids

try {
    $result = $apiInstance->setRoleGroups($role_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->setRoleGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
role_id	string	id of role
body	string[]	Array of Group Ids

Return type

\Swagger\Client\Model\Group[]

Authorization

No authorization required

HTTP request headers

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

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

setRoleUsers

\Swagger\Client\Model\User[] setRoleUsers($role_id, $body)

Update Role Users

Set all the users of the role with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$role_id = "role_id_example"; // string | id of role
$body = array(new \Swagger\Client\Model\string[]()); // string[] | array of user ids for role

try {
    $result = $apiInstance->setRoleUsers($role_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->setRoleUsers: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
role_id	string	id of role
body	string[]	array of user ids for role

Return type

\Swagger\Client\Model\User[]

Authorization

No authorization required

HTTP request headers

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

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

updateModelSet

\Swagger\Client\Model\ModelSet updateModelSet($model_set_id, $body)

Update Model Set

Update information about the model set with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$model_set_id = "model_set_id_example"; // string | id of model set
$body = new \Swagger\Client\Model\ModelSet(); // \Swagger\Client\Model\ModelSet | ModelSet

try {
    $result = $apiInstance->updateModelSet($model_set_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->updateModelSet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
model_set_id	string	id of model set
body	\Swagger\Client\Model\ModelSet	ModelSet

Return type

\Swagger\Client\Model\ModelSet

Authorization

No authorization required

HTTP request headers

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

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

updatePermissionSet

\Swagger\Client\Model\PermissionSet updatePermissionSet($permission_set_id, $body)

Update Permission Set

Update information about the permission set with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$permission_set_id = "permission_set_id_example"; // string | Id of permission set
$body = new \Swagger\Client\Model\PermissionSet(); // \Swagger\Client\Model\PermissionSet | Permission Set

try {
    $result = $apiInstance->updatePermissionSet($permission_set_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->updatePermissionSet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
permission_set_id	string	Id of permission set
body	\Swagger\Client\Model\PermissionSet	Permission Set

Return type

\Swagger\Client\Model\PermissionSet

Authorization

No authorization required

HTTP request headers

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

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

updateRole

\Swagger\Client\Model\Role updateRole($role_id, $body)

Update Role

Update information about the role with a specific id.

Example

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

$apiInstance = new Swagger\Client\Api\RoleApi(
    // 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()
);
$role_id = "role_id_example"; // string | id of role
$body = new \Swagger\Client\Model\Role(); // \Swagger\Client\Model\Role | Role

try {
    $result = $apiInstance->updateRole($role_id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling RoleApi->updateRole: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
role_id	string	id of role
body	\Swagger\Client\Model\Role	Role

Return type

\Swagger\Client\Model\Role

Authorization

No authorization required

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

RoleApi.md

Latest commit

History

RoleApi.md

File metadata and controls

Swagger\Client\RoleApi

allModelSets

Get information about all model sets.

Example

Parameters

Return type

Authorization

HTTP request headers

allPermissionSets

Get information about all permission sets.

Example

Parameters

Return type

Authorization

HTTP request headers

allPermissions

Get all supported permissions.

Example

Parameters

Return type

Authorization

HTTP request headers

allRoles

Get information about all roles.

Example

Parameters

Return type

Authorization

HTTP request headers

createModelSet

Create a model set with the specified information. Model sets are used by Roles.

Example

Parameters

Return type

Authorization

HTTP request headers

createPermissionSet

Create a permission set with the specified information. Permission sets are used by Roles.

Example

Parameters

Return type

Authorization

HTTP request headers

createRole

Create a role with the specified information.

Example

Parameters

Return type

Authorization

HTTP request headers

deleteModelSet

Delete the model set with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

deletePermissionSet

Delete the permission set with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

deleteRole

Delete the role with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

modelSet

Get information about the model set with a specific id.

Example