module Keycloak::GroupClient
Direct including types
Defined in:
keycloak/client/group.crInstance Method Summary
- #add_user_to_group(*, user_id : String, group_id : String)
- #create_group(user : Representation::Group, *, parent : String | Nil = nil)
- #delete_group(id : String)
- #get_group(id : String) : Representation::Group
-
#group_count : Int32
Returns the number of groups for the realm
-
#group_members(id : String, *, brief : Bool | Nil = nil, first : Int32 | Nil = nil, max : Int32 | Nil = nil) : Array(Representation::User)
Get groups members returns a stream of users, filtered according to query parameters
-
#groups(*, brief : Bool | Nil = nil, exact : Bool | Nil = nil, first : Int32 | Nil = nil, max : Int32 | Nil = nil, q : String | Nil = nil, search : String | Nil = nil) : Array(Representation::Group)
Get group hierarchy.
- #remove_user_from_group(*, user_id : String, group_id : String)
-
#user_group_count(id : String) : Int32
Returns the number of groups of the user
Instance Method Detail
def group_members(id : String, *, brief : Bool | Nil = nil, first : Int32 | Nil = nil, max : Int32 | Nil = nil) : Array(Representation::User)
#
Get groups members returns a stream of users, filtered according to query parameters
briefBoolean which defines whether brief representations are returnedfirstPagination offsetmaxMaximum results size (defaults to 100)
def groups(*, brief : Bool | Nil = nil, exact : Bool | Nil = nil, first : Int32 | Nil = nil, max : Int32 | Nil = nil, q : String | Nil = nil, search : String | Nil = nil) : Array(Representation::Group)
#
Get group hierarchy.
briefBoolean which defines whether brief representations are returnedfirstPagination offsetmaxMaximum results size (defaults to 100)qA query to search for custom attributes, in the format 'key1:value2 key2:value2'searchA String contained in username, first or last name, or email