swagger_client.RoleApi

All URIs are relative to https://insight.symphonyrm.com:19999/api/3.0

Method	HTTP request	Description
all_model_sets	GET /model_sets	Get All Model Sets
all_permission_sets	GET /permission_sets	Get All Permission Sets
all_permissions	GET /permissions	Get All Permissions
all_roles	GET /roles	Get All Roles
create_model_set	POST /model_sets	Create Model Set
create_permission_set	POST /permission_sets	Create Permission Set
create_role	POST /roles	Create Role
delete_model_set	DELETE /model_sets/{model_set_id}	Delete Model Set
delete_permission_set	DELETE /permission_sets/{permission_set_id}	Delete Permission Set
delete_role	DELETE /roles/{role_id}	Delete Role
model_set	GET /model_sets/{model_set_id}	Get Model Set
permission_set	GET /permission_sets/{permission_set_id}	Get Permission Set
role	GET /roles/{role_id}	Get Role
role_groups	GET /roles/{role_id}/groups	Get Role Groups
role_users	GET /roles/{role_id}/users	Get Role Users
set_role_groups	PUT /roles/{role_id}/groups	Update Role Groups
set_role_users	PUT /roles/{role_id}/users	Update Role Users
update_model_set	PATCH /model_sets/{model_set_id}	Update Model Set
update_permission_set	PATCH /permission_sets/{permission_set_id}	Update Permission Set
update_role	PATCH /roles/{role_id}	Update Role

all_model_sets

list[ModelSet] all_model_sets(fields=fields)

Get All Model Sets

Get information about all model sets.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get All Model Sets
    api_response = api_instance.all_model_sets(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->all_model_sets: %s\n" % e)

Parameters

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

Return type

list[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]

all_permission_sets

list[PermissionSet] all_permission_sets(fields=fields)

Get All Permission Sets

Get information about all permission sets.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get All Permission Sets
    api_response = api_instance.all_permission_sets(fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->all_permission_sets: %s\n" % e)

Parameters

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

Return type

list[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]

all_permissions

list[Permission] all_permissions()

Get All Permissions

Get all supported permissions.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()

try: 
    # Get All Permissions
    api_response = api_instance.all_permissions()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->all_permissions: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

list[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]

all_roles

list[Role] all_roles(fields=fields, ids=ids)

Get All Roles

Get information about all roles.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
fields = 'fields_example' # str | Requested fields. (optional)
ids = [56] # list[int] | Optional list of ids to get specific roles. (optional)

try: 
    # Get All Roles
    api_response = api_instance.all_roles(fields=fields, ids=ids)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->all_roles: %s\n" % e)

Parameters

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

Return type

list[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]

create_model_set

ModelSet create_model_set(body=body)

Create Model Set

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

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
body = swagger_client.ModelSet() # ModelSet | ModelSet (optional)

try: 
    # Create Model Set
    api_response = api_instance.create_model_set(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->create_model_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	ModelSet	ModelSet	[optional]

Return type

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]

create_permission_set

PermissionSet create_permission_set(body=body)

Create Permission Set

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

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
body = swagger_client.PermissionSet() # PermissionSet | Permission Set (optional)

try: 
    # Create Permission Set
    api_response = api_instance.create_permission_set(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->create_permission_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	PermissionSet	Permission Set	[optional]

Return type

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]

create_role

Role create_role(body=body)

Create Role

Create a role with the specified information.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
body = swagger_client.Role() # Role | Role (optional)

try: 
    # Create Role
    api_response = api_instance.create_role(body=body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->create_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
body	Role	Role	[optional]

Return type

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]

delete_model_set

str delete_model_set(model_set_id)

Delete Model Set

Delete the model set with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
model_set_id = 789 # int | id of model set

try: 
    # Delete Model Set
    api_response = api_instance.delete_model_set(model_set_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->delete_model_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_set_id	int	id of model set

Return type

str

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]

delete_permission_set

str delete_permission_set(permission_set_id)

Delete Permission Set

Delete the permission set with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
permission_set_id = 789 # int | Id of permission set

try: 
    # Delete Permission Set
    api_response = api_instance.delete_permission_set(permission_set_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->delete_permission_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
permission_set_id	int	Id of permission set

Return type

str

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]

delete_role

str delete_role(role_id)

Delete Role

Delete the role with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
role_id = 789 # int | id of role

try: 
    # Delete Role
    api_response = api_instance.delete_role(role_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->delete_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	int	id of role

Return type

str

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]

model_set

ModelSet model_set(model_set_id, fields=fields)

Get Model Set

Get information about the model set with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
model_set_id = 789 # int | Id of model set
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get Model Set
    api_response = api_instance.model_set(model_set_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->model_set: %s\n" % e)

Parameters

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

Return type

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]

permission_set

PermissionSet permission_set(permission_set_id, fields=fields)

Get Permission Set

Get information about the permission set with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
permission_set_id = 789 # int | Id of permission set
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get Permission Set
    api_response = api_instance.permission_set(permission_set_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->permission_set: %s\n" % e)

Parameters

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

Return type

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

Role role(role_id)

Get Role

Get information about the role with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
role_id = 789 # int | id of role

try: 
    # Get Role
    api_response = api_instance.role(role_id)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	int	id of role

Return type

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]

role_groups

list[Group] role_groups(role_id, fields=fields)

Get Role Groups

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

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
role_id = 789 # int | id of role
fields = 'fields_example' # str | Requested fields. (optional)

try: 
    # Get Role Groups
    api_response = api_instance.role_groups(role_id, fields=fields)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->role_groups: %s\n" % e)

Parameters

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

Return type

list[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]

role_users

list[User] role_users(role_id, fields=fields, direct_association_only=direct_association_only)

Get Role Users

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

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
role_id = 789 # int | id of user
fields = 'fields_example' # str | Requested fields. (optional)
direct_association_only = true # bool | Get only users associated directly with the role: exclude those only associated through groups. (optional)

try: 
    # Get Role Users
    api_response = api_instance.role_users(role_id, fields=fields, direct_association_only=direct_association_only)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->role_users: %s\n" % e)

Parameters

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

Return type

list[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]

set_role_groups

list[Group] set_role_groups(role_id, body)

Update Role Groups

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

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
role_id = 789 # int | Id of Role
body = [swagger_client.list[int]()] # list[int] | Array of Group Ids

try: 
    # Update Role Groups
    api_response = api_instance.set_role_groups(role_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->set_role_groups: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	int	Id of Role
body	list[int]	Array of Group Ids

Return type

list[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]

set_role_users

list[User] set_role_users(role_id, body)

Update Role Users

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

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
role_id = 789 # int | id of role
body = [swagger_client.list[int]()] # list[int] | array of user ids for role

try: 
    # Update Role Users
    api_response = api_instance.set_role_users(role_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->set_role_users: %s\n" % e)

Parameters

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

Return type

list[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]

update_model_set

ModelSet update_model_set(model_set_id, body)

Update Model Set

Update information about the model set with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
model_set_id = 789 # int | id of model set
body = swagger_client.ModelSet() # ModelSet | ModelSet

try: 
    # Update Model Set
    api_response = api_instance.update_model_set(model_set_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->update_model_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
model_set_id	int	id of model set
body	ModelSet	ModelSet

Return type

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]

update_permission_set

PermissionSet update_permission_set(permission_set_id, body)

Update Permission Set

Update information about the permission set with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
permission_set_id = 789 # int | id of permission set
body = swagger_client.PermissionSet() # PermissionSet | Permission Set

try: 
    # Update Permission Set
    api_response = api_instance.update_permission_set(permission_set_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->update_permission_set: %s\n" % e)

Parameters

Name	Type	Description	Notes
permission_set_id	int	id of permission set
body	PermissionSet	Permission Set

Return type

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]

update_role

Role update_role(role_id, body)

Update Role

Update information about the role with a specific id.

Example

from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# create an instance of the API class
api_instance = swagger_client.RoleApi()
role_id = 789 # int | id of role
body = swagger_client.Role() # Role | Role

try: 
    # Update Role
    api_response = api_instance.update_role(role_id, body)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling RoleApi->update_role: %s\n" % e)

Parameters

Name	Type	Description	Notes
role_id	int	id of role
body	Role	Role

Return type

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

all_model_sets

Get information about all model sets.

Example

Parameters

Return type

Authorization

HTTP request headers

all_permission_sets

Get information about all permission sets.

Example

Parameters

Return type

Authorization

HTTP request headers

all_permissions

Get all supported permissions.

Example

Parameters

Return type

Authorization

HTTP request headers

all_roles

Get information about all roles.

Example

Parameters

Return type

Authorization

HTTP request headers

create_model_set

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

Example

Parameters

Return type

Authorization

HTTP request headers

create_permission_set

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

Example

Parameters

Return type

Authorization

HTTP request headers

create_role

Create a role with the specified information.

Example

Parameters

Return type

Authorization

HTTP request headers

delete_model_set

Delete the model set with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

delete_permission_set

Delete the permission set with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

delete_role

Delete the role with a specific id.

Example

Parameters

Return type

Authorization

HTTP request headers

model_set

Get information about the model set with a specific id.

Example