Organizations and enterprises¶

Organizations and enterprises are the namespaces that repositories belong to. With the API you can create organizations, query and update organization profiles, manage organization members, memberships, and custom roles, and query enterprise members and their role permissions.

Organizations (org) and enterprises (enterprise) are two parallel path prefixes. Member endpoints exist on both sides, but their fields and role enums are not exactly the same.

Objects¶

Identifier scheme¶

• Organizations are identified by the path parameter org (organization path); enterprises are identified by enterprise.
• Members are identified by username; the identity of the authorized user within an organization is represented by /user/memberships/orgs/{org}.
• There are two entry points for the organizations a user belongs to: /users/{username}/orgs and /users/orgs; the latter refers to the current authorized user.

Common tasks¶

Notes¶

• Inviting and removing members use the same path …/orgs/{org}/memberships/{username}, distinguished by the HTTP method: POST invites and DELETE removes.
• "List the organizations belonging to the authorized user" is GET /api/v5/users/orgs, which has no {username} in the path; the version with {username} queries the public organizations of any user.
• Leaving an organization and querying your own member profile in an organization both use /api/v5/user/memberships/orgs/{org}. They take the authorized user's perspective and are not under /orgs/.
• Member endpoints on the enterprise side have the prefix /api/v5/enterprises/{enterprise}/…, parallel to /api/v5/orgs/{org}/… on the organization side, and their role enums also differ (the enterprise side includes viewer, tester, developer, and so on).
• An organization's issue status and board configuration have a dedicated endpoint; the endpoints for issues themselves are in the Issue group.

Endpoint list¶

This module contains 17 endpoints.