Method: Auth0::Api::V2::Users#get_user_roles

Defined in:
lib/auth0/api/v2/users.rb

#get_user_roles(user_id, options = {}) ⇒ json

Get all roles assigned to a specific user.

Parameters:

  • user_id (string) —

    The user_id of the roles to retrieve.

  • options (hash) (defaults to: {}) —

    • :per_page [integer] The amount of entries per page. Default: 50. Max value: 100.

    • :page [integer] The page number. Zero based.

    • :include_totals [boolean] True if a query summary must be included in the result.

    • :sort [string] The field to use for sorting. 1 == ascending and -1 == descending.

Returns:

  • (json) —

    Returns roles for the given user_id.

Raises:

See Also:



212
213
214
215
216
217
218
219
220
221
 
# File 'lib/auth0/api/v2/users.rb', line 212

def get_user_roles(user_id, options = {})
  raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
  path = "#{users_path}/#{user_id}/roles"
  request_params = {
    per_page:       options.fetch(:per_page, nil),
    page:           options.fetch(:page, nil),
    include_totals: options.fetch(:include_totals, nil)
  }
  get(path, request_params)
end