You can also view Looker’s interactive API documentation on the Looker Developer Portal or by using the API Explorer extension.
Search Model Sets
Implementation Notes
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.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
limit | false | Number of results to return (used with `offset`). | integer | int64 |
offset | false | Number of results to skip before returning any (used with `limit`). | integer | int64 |
sorts | false | Fields to sort by. | string | string |
id | false | Match model set id. | string | string |
name | false | Match model set name. | string | string |
all_access | false | Match model sets by all_access status. | boolean | boolean |
built_in | false | Match model sets by built_in status. | boolean | boolean |
filter_or | false | Combine given search criteria in a boolean OR expression. | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Model Set
Implementation Notes
Get information about the model set with a specific id.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
model_set_id | true | Id of model set | string | string |
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Delete Model Set
Implementation Notes
Delete the model set with a specific id.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
model_set_id | true | id of model set | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
405 | Resource Can’t Be Modified |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Model set successfully deleted. | string |
Update Model Set
Implementation Notes
Update information about the model set with a specific id.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
model_set_id | true | id of model set | string | string |
body | true | ModelSet | body |
ModelSet {
can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, models (Array[string]), name (string): Name of ModelSet, url (string, read-only): Link to get this item }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
405 | Resource Can’t Be Modified |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
Get All Model Sets
Implementation Notes
Get information about all model sets.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Model Set
Implementation Notes
Create a model set with the specified information. Model sets are used by Roles.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
body | true | ModelSet | body |
ModelSet {
can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, models (Array[string]), name (string): Name of ModelSet, url (string, read-only): Link to get this item }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
Get All Permissions
Implementation Notes
Get all supported permissions.
Response Class
array
Parameters
None
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Search Permission Sets
Implementation Notes
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.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
limit | false | Number of results to return (used with `offset`). | integer | int64 |
offset | false | Number of results to skip before returning any (used with `limit`). | integer | int64 |
sorts | false | Fields to sort by. | string | string |
id | false | Match permission set id. | string | string |
name | false | Match permission set name. | string | string |
all_access | false | Match permission sets by all_access status. | boolean | boolean |
built_in | false | Match permission sets by built_in status. | boolean | boolean |
filter_or | false | Combine given search criteria in a boolean OR expression. | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Permission Set
Implementation Notes
Get information about the permission set with a specific id.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
permission_set_id | true | Id of permission set | string | string |
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Delete Permission Set
Implementation Notes
Delete the permission set with a specific id.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
permission_set_id | true | Id of permission set | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
405 | Resource Can’t Be Modified |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Successfully deleted. | string |
Update Permission Set
Implementation Notes
Update information about the permission set with a specific id.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
permission_set_id | true | Id of permission set | string | string |
body | true | Permission Set | body |
PermissionSet {
can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, name (string): Name of PermissionSet, permissions (Array[string]), url (string, read-only): Link to get this item }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
405 | Resource Can’t Be Modified |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All Permission Sets
Implementation Notes
Get information about all permission sets.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Permission Set
Implementation Notes
Create a permission set with the specified information. Permission sets are used by Roles.
Response Class
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
body | true | Permission Set | body |
PermissionSet {
can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, name (string): Name of PermissionSet, permissions (Array[string]), url (string, read-only): Link to get this item }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get All Roles
Implementation Notes
Get information about all roles.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
ids | false | Optional list of ids to get specific roles. | array | array |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Create Role
Implementation Notes
Create a role with the specified information.
Response Class
PermissionSet {
ModelSet {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
body | true | Role | body |
Role {
can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Unique Id, name (string): Name of Role, permission_set (PermissionSet, read-only): (Read only) Permission set, permission_set_id (string): (Write-Only) Id of permission set, model_set (ModelSet, read-only): (Read only) Model set, model_set_id (string): (Write-Only) Id of model set, url (string, read-only): Link to get this item, users_url (string, read-only): Link to get list of users with this role }PermissionSet { can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, name (string): Name of PermissionSet, permissions (Array[string]), url (string, read-only): Link to get this item }ModelSet { can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, models (Array[string]), name (string): Name of ModelSet, url (string, read-only): Link to get this item }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
409 | Resource Already Exists |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Search Roles
Implementation Notes
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.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
limit | false | Number of results to return (used with `offset`). | integer | int64 |
offset | false | Number of results to skip before returning any (used with `limit`). | integer | int64 |
sorts | false | Fields to sort by. | string | string |
id | false | Match role id. | string | string |
name | false | Match role name. | string | string |
built_in | false | Match roles by built_in status. | boolean | boolean |
filter_or | false | Combine given search criteria in a boolean OR expression. | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Search Roles with User Count beta
Implementation Notes
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.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
fields | false | Requested fields. | string | string |
limit | false | Number of results to return (used with `offset`). | integer | int64 |
offset | false | Number of results to skip before returning any (used with `limit`). | integer | int64 |
sorts | false | Fields to sort by. | string | string |
id | false | Match role id. | string | string |
name | false | Match role name. | string | string |
built_in | false | Match roles by built_in status. | boolean | boolean |
filter_or | false | Combine given search criteria in a boolean OR expression. | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Role
Implementation Notes
Get information about the role with a specific id.
Response Class
PermissionSet {
ModelSet {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
role_id | true | id of role | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Delete Role
Implementation Notes
Delete the role with a specific id.
Response Class
None
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
role_id | true | id of role | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
405 | Resource Can’t Be Modified |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
204 | Successfully deleted. | string |
Update Role
Implementation Notes
Update information about the role with a specific id.
Response Class
PermissionSet {
ModelSet {
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
role_id | true | id of role | string | string |
body | true | Role | body |
Role {
can (object, read-only): Operations the current user is able to perform on this object, id (string, read-only): Unique Id, name (string): Name of Role, permission_set (PermissionSet, read-only): (Read only) Permission set, permission_set_id (string): (Write-Only) Id of permission set, model_set (ModelSet, read-only): (Read only) Model set, model_set_id (string): (Write-Only) Id of model set, url (string, read-only): Link to get this item, users_url (string, read-only): Link to get list of users with this role }PermissionSet { can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, name (string): Name of PermissionSet, permissions (Array[string]), url (string, read-only): Link to get this item }ModelSet { can (object, read-only): Operations the current user is able to perform on this object, all_access (boolean, read-only), built_in (boolean, read-only), id (string, read-only): Unique Id, models (Array[string]), name (string): Name of ModelSet, url (string, read-only): Link to get this item }
|
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
405 | Resource Can’t Be Modified |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Role Groups
Implementation Notes
Get information about all the groups with the role that has a specific id.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
role_id | true | id of role | string | string |
fields | false | Requested fields. | string | string |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Role Groups
Implementation Notes
Set all groups for a role, removing all existing group associations from that role.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
role_id | true | id of role | string | string |
body | true | Array of Group Ids | body | array |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Get Role Users
Implementation Notes
Get information about all the users with the role that has a specific id.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
role_id | true | id of role | string | string |
fields | false | Requested fields. | string | string |
direct_association_only | false | Get only users associated directly with the role: exclude those only associated through groups. | boolean | boolean |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
Update Role Users
Implementation Notes
Set all the users of the role with a specific id.
Response Class
array
Parameters
Parameter | Required? | Description | Parameter Type | Data Type |
---|---|---|---|---|
role_id | true | id of role | string | string |
body | true | array of user ids for role | body | array |
Response Messages
HTTP Status Code | Reason | Response Model |
---|---|---|
400 | Bad Request |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
404 | Not Found |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
422 | Validation Error |
ValidationError {
message (string, read-only, required): Error details, errors (Array[ValidationErrorDetail], read-only): Error detail array, documentation_url (string, read-only, required): Documentation link }ValidationErrorDetail { field (string, read-only): Field with error, code (string, read-only): Error code, message (string, read-only): Error info message, documentation_url (string, read-only, required): Documentation link }
|
429 | Too Many Requests |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
405 | Resource Can’t Be Modified |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|
403 | Permission Denied |
Error {
message (string, read-only, required): Error details, documentation_url (string, read-only, required): Documentation link }
|