LookerApi31Reference.RoleApi

All URIs are relative to /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
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

[ModelSet] allModelSets(opts)

Get All Model Sets

Get information about all model sets.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allModelSets(opts, callback);

Parameters

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

Return type

[ModelSet]

Authorization

No authorization required

HTTP request headers

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

allPermissionSets

[PermissionSet] allPermissionSets(opts)

Get All Permission Sets

Get information about all permission sets.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allPermissionSets(opts, callback);

Parameters

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

Return type

[PermissionSet]

Authorization

No authorization required

HTTP request headers

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

allPermissions

[Permission] allPermissions()

Get All Permissions

Get all supported permissions.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allPermissions(callback);

Parameters

This endpoint does not need any parameter.

Return type

[Permission]

Authorization

No authorization required

HTTP request headers

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

allRoles

[Role] allRoles(opts)

Get All Roles

Get information about all roles.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var opts = {
  'fields': "fields_example", // String | Requested fields.
  'ids': [3.4] // [Number] | Optional list of ids to get specific roles.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allRoles(opts, callback);

Parameters

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

Return type

[Role]

Authorization

No authorization required

HTTP request headers

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

createModelSet

ModelSet createModelSet(opts)

Create Model Set

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

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var opts = {
  'body': new LookerApi31Reference.ModelSet() // ModelSet | ModelSet
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createModelSet(opts, callback);

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

createPermissionSet

PermissionSet createPermissionSet(opts)

Create Permission Set

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

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var opts = {
  'body': new LookerApi31Reference.PermissionSet() // PermissionSet | Permission Set
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createPermissionSet(opts, callback);

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

createRole

Role createRole(opts)

Create Role

Create a role with the specified information.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var opts = {
  'body': new LookerApi31Reference.Role() // Role | Role
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createRole(opts, callback);

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

deleteModelSet

'String' deleteModelSet(modelSetId)

Delete Model Set

Delete the model set with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var modelSetId = 789; // Number | id of model set


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteModelSet(modelSetId, callback);

Parameters

Name	Type	Description	Notes
modelSetId	Number	id of model set

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

deletePermissionSet

'String' deletePermissionSet(permissionSetId)

Delete Permission Set

Delete the permission set with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var permissionSetId = 789; // Number | Id of permission set


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deletePermissionSet(permissionSetId, callback);

Parameters

Name	Type	Description	Notes
permissionSetId	Number	Id of permission set

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

deleteRole

'String' deleteRole(roleId)

Delete Role

Delete the role with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var roleId = 789; // Number | id of role


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deleteRole(roleId, callback);

Parameters

Name	Type	Description	Notes
roleId	Number	id of role

Return type

'String'

Authorization

No authorization required

HTTP request headers

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

modelSet

ModelSet modelSet(modelSetId, opts)

Get Model Set

Get information about the model set with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var modelSetId = 789; // Number | Id of model set

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.modelSet(modelSetId, opts, callback);

Parameters

Name	Type	Description	Notes
modelSetId	Number	Id of model set
fields	String	Requested fields.	[optional]

Return type

ModelSet

Authorization

No authorization required

HTTP request headers

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

permissionSet

PermissionSet permissionSet(permissionSetId, opts)

Get Permission Set

Get information about the permission set with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var permissionSetId = 789; // Number | Id of permission set

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.permissionSet(permissionSetId, opts, callback);

Parameters

Name	Type	Description	Notes
permissionSetId	Number	Id of permission set
fields	String	Requested fields.	[optional]

Return type

PermissionSet

Authorization

No authorization required

HTTP request headers

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

role

Role role(roleId)

Get Role

Get information about the role with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var roleId = 789; // Number | id of role


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.role(roleId, callback);

Parameters

Name	Type	Description	Notes
roleId	Number	id of role

Return type

Role

Authorization

No authorization required

HTTP request headers

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

roleGroups

[Group] roleGroups(roleId, opts)

Get Role Groups

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

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var roleId = 789; // Number | id of role

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.roleGroups(roleId, opts, callback);

Parameters

Name	Type	Description	Notes
roleId	Number	id of role
fields	String	Requested fields.	[optional]

Return type

[Group]

Authorization

No authorization required

HTTP request headers

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

roleUsers

[User] roleUsers(roleId, opts)

Get Role Users

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

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var roleId = 789; // Number | id of user

var opts = {
  'fields': "fields_example", // String | Requested fields.
  'directAssociationOnly': true // Boolean | Get only users associated directly with the role: exclude those only associated through groups.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.roleUsers(roleId, opts, callback);

Parameters

Name	Type	Description	Notes
roleId	Number	id of user
fields	String	Requested fields.	[optional]
directAssociationOnly	Boolean	Get only users associated directly with the role: exclude those only associated through groups.	[optional]

Return type

[User]

Authorization

No authorization required

HTTP request headers

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

setRoleGroups

[Group] setRoleGroups(roleId, body)

Update Role Groups

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

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var roleId = 789; // Number | Id of Role

var body = [new LookerApi31Reference.[Number]()]; // [Number] | Array of Group Ids


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.setRoleGroups(roleId, body, callback);

Parameters

Name	Type	Description	Notes
roleId	Number	Id of Role
body	[Number]	Array of Group Ids

Return type

[Group]

Authorization

No authorization required

HTTP request headers

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

setRoleUsers

[User] setRoleUsers(roleId, body)

Update Role Users

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

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var roleId = 789; // Number | id of role

var body = [new LookerApi31Reference.[Number]()]; // [Number] | array of user ids for role


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.setRoleUsers(roleId, body, callback);

Parameters

Name	Type	Description	Notes
roleId	Number	id of role
body	[Number]	array of user ids for role

Return type

[User]

Authorization

No authorization required

HTTP request headers

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

updateModelSet

ModelSet updateModelSet(modelSetId, body)

Update Model Set

Update information about the model set with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var modelSetId = 789; // Number | id of model set

var body = new LookerApi31Reference.ModelSet(); // ModelSet | ModelSet


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateModelSet(modelSetId, body, callback);

Parameters

Name	Type	Description	Notes
modelSetId	Number	id of model set
body	ModelSet	ModelSet

Return type

ModelSet

Authorization

No authorization required

HTTP request headers

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

updatePermissionSet

PermissionSet updatePermissionSet(permissionSetId, body)

Update Permission Set

Update information about the permission set with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var permissionSetId = 789; // Number | id of permission set

var body = new LookerApi31Reference.PermissionSet(); // PermissionSet | Permission Set


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updatePermissionSet(permissionSetId, body, callback);

Parameters

Name	Type	Description	Notes
permissionSetId	Number	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

updateRole

Role updateRole(roleId, body)

Update Role

Update information about the role with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.RoleApi();

var roleId = 789; // Number | id of role

var body = new LookerApi31Reference.Role(); // Role | Role


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateRole(roleId, body, callback);

Parameters

Name	Type	Description	Notes
roleId	Number	id of role
body	Role	Role

Return type

Role

Authorization

No authorization required

HTTP request headers

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

Files

RoleApi.md

Latest commit

History

RoleApi.md

File metadata and controls

LookerApi31Reference.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