Class RoleAPI

Role API

This is the main class to communicate with LoginRadius Customer Registration Role API.

Namespace: LoginRadiusSDK\CustomerRegistration\Account
Located at LoginRadiusSDK/CustomerRegistration/Account/RoleAPI.php

Methods summary
`public`	# `__construct( type $apikey = '', type $apisecret = '', type $options = array() )` Parameters `$apikey` `$apisecret` `$options`
`public type`	# `create( $roles, $fields = '*' )` Create Roles. Create Roles. Parameters `$roles` data { "Roles":[ { "Name":"Administrator", "Permissions":{ "Edit":true, "Manage":true } } ] } `$fields` Returns type
`public type`	# `getContext( $uid, $fields = '*' )` Get Context with Roles and Permissions. Get Context with Roles and Permissions. Parameters `$uid` xxxxxxxxxxxxxxxxxxxxx; `$fields` Returns type
`public type`	# `get( $fields = '*' )` Get Role of customer. Get Role of customer. Returns type
`public type`	# `getAccountRolesByUid( $uid, $fields = '*' )` Get Account Role by uid. Get Account Role by uid. Parameters `$uid` `$fields` Returns type
`public`	# `addPermission( $role, $permissions, $fields = '*' )` This API is used to add permission to role.. This API is used to add permission to role.. $role = 'xxxxxx'; // role name $permissions = { "permissions": [ "permission_name1", "permission_name2" ] } return object
`public type`	# `assignRolesByUid( $uid, $data, $fields = '*' )` Insert role to account. Insert role to account. Parameters `$uid` `$data` {"roles": ["role_name"]} `$fields` Returns type
`public type`	# `upsertContext( $uid, $rolesContext, $fields = '*' )` Add/Update Roles Context. Add/Update Roles Context. Parameters `$uid` xxxxxxxxxxxxxxxxxxxxx; `$rolesContext` data { "RoleContext": [ { "Context": "Home", "Roles": ["admin","user"], "AdditionalPermissions": ["X","Y","Z"] }, { "Context": "Work", "Roles": ["admin"], "AdditionalPermissions": ["X","Y","Z"] } ] } `$fields` Returns type
`public`	# `delete( $role, $fields = '*' )` Delete role. Delete role. $role = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'; //Name of Role return {IsDeleted : true}
`public type`	# `deleteAccountRoles( $uid, $data, $fields = '*' )` Unassign Roles by UID. Unassign Roles by UID. Parameters `$uid` `$data` {"roles": ["role_name"]} `$fields` Returns type
`public`	# `removePermission( $role, $permissions, $fields = '*' )` This API is used to remove permission to role. This API is used to remove permission to role. $role = 'xxxxxx'; // role name $permissions = { "permissions": [ "permission_name1" ] } return { "Name" : "Editor", "Permissions" :[{"Permission" : true},{"Permission" : true}]}
`public type`	# `deleteContextbyContextName( $uid, $roleContextName, $fields = '*' )` Delete Roles Context by Role Context Name Delete Roles Context by Role Context Name Parameters `$uid` xxxxxxxxxxxxxxxxxxxxx; `$roleContextName` data `$fields` Returns type
`public type`	# `deleteRoleFromContext( type $uid, type $roleContextName, $roles, $fields = '*' )` Delete Roles From Context Delete Roles From Context Parameters `$uid` `$roleContextName` $roles { "Role" : ["admin"] } `$roles` `$fields` Returns type
`public type`	# `deleteAdditionalPermissionFromContext( type $uid, type $roleContextName, type $additionalPermission, $fields = '' )` Delete Additional Permission by Role Context Name Delete Additional Permission by Role Context Name Parameters `$uid` `$roleContextName` `$additionalPermission` Json data { "AdditionalPermissions": ["X"] } `$fields` Returns type