MembersEndpointGroup

public class MembersEndpointGroup : EndpointGroup

This EndpointGroup communicates with Grou and project members API

Grou and project members API

Valid access levels

The access levels are defined in the Gitlab::Access module. Currently, these levels are recognized:

10 => Guest access
20 => Reporter access
30 => Developer access
40 => Maintainer access
50 => Owner access # Only valid for groups

  • List all members of a group

    Gets a list of group members viewable by the authenticated user. Returns only direct members and not inherited members through ancestors groups.

    Optional Query Parameter:

    • query: String - A query string to search for members

    Declaration

    Swift

    public func get(groupID: Int, parameters: QueryParameters? = nil) -> Observable<[Member]>

    Parameters

    groupID

    The ID or URL-encoded path of the group owned by the authenticated user
    parameters

    See Query Parameters in the description

    Return Value

    An Observable of list of Members

  • List all members of a project

    Gets a list of project members viewable by the authenticated user. Returns only direct members and not inherited members through ancestors groups.

    Optional Query Parameter:

    • query: String - A query string to search for members

    Declaration

    Swift

    public func get(projectID: Int, parameters: QueryParameters? = nil ) -> Observable<[Member]>

    Parameters

    projectID

    The ID or URL-encoded path of the project owned by the authenticated user
    parameters

    See Query Parameters in the description

    Return Value

    An Observable of list of Members

  • Undocumented

    Declaration

    Swift

    public func getSingle(groupID: Int, userID: Int, parameters: QueryParameters? = nil) -> Observable<Member>

  • Undocumented

    Declaration

    Swift

    public func getSingle(projectID: Int, userID: Int, parameters: QueryParameters? = nil) -> Observable<Member>

  • List all members of a group or project including inherited members

    Gets a list of group members viewable by the authenticated user, including inherited members through ancestor groups. Returns multiple times the same user (with different member attributes) when the user is a member of the project/group and of one or more ancestor group.

    Optional Query Parameter:

    • query: String - A query string to search for members

    Declaration

    Swift

    public func getAll(groupID: Int, parameters: QueryParameters? = nil) -> Observable<[Member]>

    Parameters

    groupID

    The ID or URL-encoded path of the group owned by the authenticated user
    parameters

    See Query Parameters in the description

    Return Value

    An Observable of list of Members

  • List all members of a project or project including inherited members

    Gets a list of project members viewable by the authenticated user, including inherited members through ancestor groups. Returns multiple times the same user (with different member attributes) when the user is a member of the project/group and of one or more ancestor group.

    Optional Query Parameter:

    • query: String - A query string to search for members

    Declaration

    Swift

    public func getAll(projectID: Int, parameters: QueryParameters? = nil) -> Observable<[Member]>

    Parameters

    projectID

    The ID or URL-encoded path of the project owned
    parameters

    See Query Parameters in the description

    Return Value

    An Observable of list of Members