Skip to content

members

WorkspaceMember

Bases: BitbucketCloudBase

Source code in server/vendor/atlassian/bitbucket/cloud/workspaces/members.py
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
class WorkspaceMember(BitbucketCloudBase):
    def __init__(self, data, *args, **kwargs):
        super(WorkspaceMember, self).__init__(None, *args, data=data, expected_type="workspace_membership", **kwargs)

    @property
    def links(self):
        """The member links"""
        return self.get_data("links")

    @property
    def type(self):
        """The member type"""
        return self.get_data("type")

    @property
    def user(self):
        """The member user dictionary"""
        return self.get_data("user")

    @property
    def workspace(self):
        """The member workspace dictionary"""
        return self.get_data("workspace")

The member links

type property

The member type

user property

The member user dictionary

workspace property

The member workspace dictionary

WorkspaceMembers

Bases: BitbucketCloudBase

Source code in server/vendor/atlassian/bitbucket/cloud/workspaces/members.py
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class WorkspaceMembers(BitbucketCloudBase):
    def __init__(self, url, *args, **kwargs):
        super(WorkspaceMembers, self).__init__(url, *args, **kwargs)

    def __get_object(self, data):
        return WorkspaceMember(data, **self._new_session_args)

    def each(self):
        """
        Get all members in the workspace

        :return: A generator for the member objects

        API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/#api-workspaces-workspace-members-get
        """
        for member in self._get_paged(None):
            yield self.__get_object(member)

        return

    def get(self, member):
        """
        Returns the requested member

        :param member: string: Member's UUID or Atlassian ID.

        :return: The requested Member object

        API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/#api-workspaces-workspace-members-member-get
        """

        return self.__get_object(super(WorkspaceMembers, self).get(member))

each()

Get all members in the workspace

:return: A generator for the member objects

API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/#api-workspaces-workspace-members-get

Source code in server/vendor/atlassian/bitbucket/cloud/workspaces/members.py
13
14
15
16
17
18
19
20
21
22
23
24
def each(self):
    """
    Get all members in the workspace

    :return: A generator for the member objects

    API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/#api-workspaces-workspace-members-get
    """
    for member in self._get_paged(None):
        yield self.__get_object(member)

    return

get(member)

Returns the requested member

:param member: string: Member's UUID or Atlassian ID.

:return: The requested Member object

API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/#api-workspaces-workspace-members-member-get

Source code in server/vendor/atlassian/bitbucket/cloud/workspaces/members.py
26
27
28
29
30
31
32
33
34
35
36
37
def get(self, member):
    """
    Returns the requested member

    :param member: string: Member's UUID or Atlassian ID.

    :return: The requested Member object

    API docs: https://developer.atlassian.com/cloud/bitbucket/rest/api-group-workspaces/#api-workspaces-workspace-members-member-get
    """

    return self.__get_object(super(WorkspaceMembers, self).get(member))