REST-API-Endpunkte für Organisationsmitglieder

List organization members

List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.

Differenzierte Zugriffstoken für "List organization members"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „List organization members“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
`filter` string Filter members returned in the list. `2fa_disabled` means that only members without two-factor authentication enabled will be returned. This options is only available for organization owners. Standard: `all` Kann eine der Folgenden sein: `2fa_disabled`, `all`
`role` string Filter members returned by their role. Standard: `all` Kann eine der Folgenden sein: `all`, `admin`, `member`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List organization members“

Statuscode	BESCHREIBUNG
`200`	OK
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „List organization members“

Anforderungsbeispiel

get/orgs/{org}/members

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/members

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Check organization membership for a user

Check if a user is, publicly or privately, a member of the organization.

Differenzierte Zugriffstoken für "Check organization membership for a user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Check organization membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Check organization membership for a user“

Statuscode	BESCHREIBUNG
`204`	Response if requester is an organization member and user is a member
`302`	Response if requester is not an organization member
`404`	Not Found if requester is an organization member and user is not a member

Codebeispiele für „Check organization membership for a user“

Anforderungsbeispiel

get/orgs/{org}/members/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/members/USERNAME

Response if requester is an organization member and user is a member

Status: 204

Remove an organization member

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

Differenzierte Zugriffstoken für "Remove an organization member"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Remove an organization member“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Remove an organization member“

Statuscode	BESCHREIBUNG
`204`	No Content
`403`	Forbidden

Codebeispiele für „Remove an organization member“

Anforderungsbeispiel

delete/orgs/{org}/members/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/members/USERNAME

Response

Status: 204

Get organization membership for a user

In order to get a user's membership with an organization, the authenticated user must be an organization member. The state parameter in the response can be used to identify the user's membership status.

Differenzierte Zugriffstoken für "Get organization membership for a user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (read)

Parameter für „Get organization membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Get organization membership for a user“

Statuscode	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „Get organization membership for a user“

Anforderungsbeispiel

get/orgs/{org}/memberships/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/memberships/USERNAME

Response if user has an active admin membership with organization

Status: 200

{
  "url": "https://HOSTNAME/orgs/octocat/memberships/defunkt",
  "state": "active",
  "role": "admin",
  "organization_url": "https://HOSTNAME/orgs/octocat",
  "organization": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "url": "https://HOSTNAME/orgs/github",
    "repos_url": "https://HOSTNAME/orgs/github/repos",
    "events_url": "https://HOSTNAME/orgs/github/events",
    "hooks_url": "https://HOSTNAME/orgs/github/hooks",
    "issues_url": "https://HOSTNAME/orgs/github/issues",
    "members_url": "https://HOSTNAME/orgs/github/members{/member}",
    "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "description": "A great organization"
  },
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
}

Set organization membership for a user

Only authenticated organization owners can add a member to the organization or update the member's role.

If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.
Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.

Rate limits

To prevent abuse, organization owners are limited to creating 50 organization invitations for an organization within a 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

Differenzierte Zugriffstoken für "Set organization membership for a user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Set organization membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

Textparameter
Name, type, BESCHREIBUNG
`role` string The role to give the user in the organization. Can be one of: `admin` - The user will become an owner of the organization. `member` - The user will become a non-owner member of the organization. Standard: `member` Kann eine der Folgenden sein: `admin`, `member`

HTTP-Antwortstatuscodes für „Set organization membership for a user“

Statuscode	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „Set organization membership for a user“

Anforderungsbeispiel

put/orgs/{org}/memberships/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/memberships/USERNAME \
  -d '{"role":"member"}'

Response if user has an active admin membership with organization

Status: 200

{
  "url": "https://HOSTNAME/orgs/octocat/memberships/defunkt",
  "state": "active",
  "role": "admin",
  "organization_url": "https://HOSTNAME/orgs/octocat",
  "organization": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "url": "https://HOSTNAME/orgs/github",
    "repos_url": "https://HOSTNAME/orgs/github/repos",
    "events_url": "https://HOSTNAME/orgs/github/events",
    "hooks_url": "https://HOSTNAME/orgs/github/hooks",
    "issues_url": "https://HOSTNAME/orgs/github/issues",
    "members_url": "https://HOSTNAME/orgs/github/members{/member}",
    "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "description": "A great organization"
  },
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
}

Remove organization membership for a user

In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

Differenzierte Zugriffstoken für "Remove organization membership for a user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Remove organization membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Remove organization membership for a user“

Statuscode	BESCHREIBUNG
`204`	No Content
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „Remove organization membership for a user“

Anforderungsbeispiel

delete/orgs/{org}/memberships/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/memberships/USERNAME

Response

Status: 204

List public organization members

Members of an organization can choose to have their membership publicized or not.

Differenzierte Zugriffstoken für "List public organization members"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „List public organization members“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Abfrageparameter
Name, type, BESCHREIBUNG
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List public organization members“

Statuscode	BESCHREIBUNG
`200`	OK

Codebeispiele für „List public organization members“

Anforderungsbeispiel

get/orgs/{org}/public_members

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/public_members

Response

Status: 200

[
  {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
]

Check public organization membership for a user

Check if the provided user is a public member of the organization.

Differenzierte Zugriffstoken für "Check public organization membership for a user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (read)

Dieser Endpunkt kann ohne Authentifizierung oder die zuvor erwähnten Berechtigungen verwendet werden, wenn nur öffentliche Ressourcen angefordert werden.

Parameter für „Check public organization membership for a user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Check public organization membership for a user“

Statuscode	BESCHREIBUNG
`204`	Response if user is a public member
`404`	Not Found if user is not a public member

Codebeispiele für „Check public organization membership for a user“

Anforderungsbeispiel

get/orgs/{org}/public_members/{username}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/public_members/USERNAME

Response if user is a public member

Status: 204

Set public organization membership for the authenticated user

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see "HTTP method."

Differenzierte Zugriffstoken für "Set public organization membership for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Set public organization membership for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Set public organization membership for the authenticated user“

Statuscode	BESCHREIBUNG
`204`	No Content
`403`	Forbidden

Codebeispiele für „Set public organization membership for the authenticated user“

Anforderungsbeispiel

put/orgs/{org}/public_members/{username}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/public_members/USERNAME

Response

Status: 204

Remove public organization membership for the authenticated user

Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default.

Differenzierte Zugriffstoken für "Remove public organization membership for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Remove public organization membership for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.
`username` string Erforderlich The handle for the GitHub user account.

HTTP-Antwortstatuscodes für „Remove public organization membership for the authenticated user“

Statuscode	BESCHREIBUNG
`204`	No Content

Codebeispiele für „Remove public organization membership for the authenticated user“

Anforderungsbeispiel

delete/orgs/{org}/public_members/{username}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/orgs/ORG/public_members/USERNAME

Response

Status: 204

List organization memberships for the authenticated user

Lists all of the authenticated user's organization memberships.

Differenzierte Zugriffstoken für "List organization memberships for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token erfordert keine Berechtigungen.

Parameter für „List organization memberships for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Abfrageparameter
Name, type, BESCHREIBUNG
`state` string Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. Kann eine der Folgenden sein: `active`, `pending`
`per_page` integer The number of results per page (max 100). For more information, see "Using pagination in the REST API." Standard: `30`
`page` integer The page number of the results to fetch. For more information, see "Using pagination in the REST API." Standard: `1`

HTTP-Antwortstatuscodes für „List organization memberships for the authenticated user“

Statuscode	BESCHREIBUNG
`200`	OK
`304`	Not modified
`401`	Requires authentication
`403`	Forbidden
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „List organization memberships for the authenticated user“

Anforderungsbeispiel

get/user/memberships/orgs

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/user/memberships/orgs

Response

Status: 200

[
  {
    "url": "https://HOSTNAME/orgs/octocat/memberships/defunkt",
    "state": "active",
    "role": "admin",
    "organization_url": "https://HOSTNAME/orgs/octocat",
    "organization": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://HOSTNAME/orgs/github",
      "repos_url": "https://HOSTNAME/orgs/github/repos",
      "events_url": "https://HOSTNAME/orgs/github/events",
      "hooks_url": "https://HOSTNAME/orgs/github/hooks",
      "issues_url": "https://HOSTNAME/orgs/github/issues",
      "members_url": "https://HOSTNAME/orgs/github/members{/member}",
      "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "description": "A great organization"
    },
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    }
  },
  {
    "url": "https://HOSTNAME/orgs/invitocat/memberships/defunkt",
    "state": "pending",
    "role": "admin",
    "organization_url": "https://HOSTNAME/orgs/invitocat",
    "organization": {
      "login": "github",
      "id": 1,
      "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
      "url": "https://HOSTNAME/orgs/github",
      "repos_url": "https://HOSTNAME/orgs/github/repos",
      "events_url": "https://HOSTNAME/orgs/github/events",
      "hooks_url": "https://HOSTNAME/orgs/github/hooks",
      "issues_url": "https://HOSTNAME/orgs/github/issues",
      "members_url": "https://HOSTNAME/orgs/github/members{/member}",
      "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "description": "A great organization"
    },
    "user": {
      "login": "octocat",
      "id": 1,
      "node_id": "MDQ6VXNlcjE=",
      "avatar_url": "https://github.com/images/error/octocat_happy.gif",
      "gravatar_id": "",
      "url": "https://HOSTNAME/users/octocat",
      "html_url": "https://github.com/octocat",
      "followers_url": "https://HOSTNAME/users/octocat/followers",
      "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
      "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
      "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
      "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
      "organizations_url": "https://HOSTNAME/users/octocat/orgs",
      "repos_url": "https://HOSTNAME/users/octocat/repos",
      "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
      "received_events_url": "https://HOSTNAME/users/octocat/received_events",
      "type": "User",
      "site_admin": false
    }
  }
]

Get an organization membership for the authenticated user

If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a 404 is returned. This endpoint will return a 403 if the request is made by a GitHub App that is blocked by the organization.

Differenzierte Zugriffstoken für "Get an organization membership for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (read)

Parameter für „Get an organization membership for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

HTTP-Antwortstatuscodes für „Get an organization membership for the authenticated user“

Statuscode	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found

Codebeispiele für „Get an organization membership for the authenticated user“

Anforderungsbeispiel

get/user/memberships/orgs/{org}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/user/memberships/orgs/ORG

Response

Status: 200

{
  "url": "https://HOSTNAME/orgs/invitocat/memberships/defunkt",
  "state": "pending",
  "role": "admin",
  "organization_url": "https://HOSTNAME/orgs/invitocat",
  "organization": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "url": "https://HOSTNAME/orgs/github",
    "repos_url": "https://HOSTNAME/orgs/github/repos",
    "events_url": "https://HOSTNAME/orgs/github/events",
    "hooks_url": "https://HOSTNAME/orgs/github/hooks",
    "issues_url": "https://HOSTNAME/orgs/github/issues",
    "members_url": "https://HOSTNAME/orgs/github/members{/member}",
    "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "description": "A great organization"
  },
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
}

Update an organization membership for the authenticated user

Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.

Differenzierte Zugriffstoken für "Update an organization membership for the authenticated user"

Dieser Endpunkt funktioniert mit den folgenden differenzierten Tokentypen.:

Das differenzierte Token muss einen der folgenden Berechtigungssätze aufweisen.:

"Members" organization permissions (write)

Parameter für „Update an organization membership for the authenticated user“

Header
Name, type, BESCHREIBUNG
`accept` string Setting to `application/vnd.github+json` is recommended.

Pfadparameter
Name, type, BESCHREIBUNG
`org` string Erforderlich The organization name. The name is not case sensitive.

Textparameter
Name, type, BESCHREIBUNG
`state` string Erforderlich The state that the membership should be in. Only `"active"` will be accepted. Wert: `active`

HTTP-Antwortstatuscodes für „Update an organization membership for the authenticated user“

Statuscode	BESCHREIBUNG
`200`	OK
`403`	Forbidden
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

Codebeispiele für „Update an organization membership for the authenticated user“

Anforderungsbeispiel

patch/user/memberships/orgs/{org}

curl -L \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/user/memberships/orgs/ORG \
  -d '{"state":"active"}'

Response

Status: 200

{
  "url": "https://HOSTNAME/orgs/octocat/memberships/defunkt",
  "state": "active",
  "role": "admin",
  "organization_url": "https://HOSTNAME/orgs/octocat",
  "organization": {
    "login": "github",
    "id": 1,
    "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=",
    "url": "https://HOSTNAME/orgs/github",
    "repos_url": "https://HOSTNAME/orgs/github/repos",
    "events_url": "https://HOSTNAME/orgs/github/events",
    "hooks_url": "https://HOSTNAME/orgs/github/hooks",
    "issues_url": "https://HOSTNAME/orgs/github/issues",
    "members_url": "https://HOSTNAME/orgs/github/members{/member}",
    "public_members_url": "https://HOSTNAME/orgs/github/public_members{/member}",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "description": "A great organization"
  },
  "user": {
    "login": "octocat",
    "id": 1,
    "node_id": "MDQ6VXNlcjE=",
    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
    "gravatar_id": "",
    "url": "https://HOSTNAME/users/octocat",
    "html_url": "https://github.com/octocat",
    "followers_url": "https://HOSTNAME/users/octocat/followers",
    "following_url": "https://HOSTNAME/users/octocat/following{/other_user}",
    "gists_url": "https://HOSTNAME/users/octocat/gists{/gist_id}",
    "starred_url": "https://HOSTNAME/users/octocat/starred{/owner}{/repo}",
    "subscriptions_url": "https://HOSTNAME/users/octocat/subscriptions",
    "organizations_url": "https://HOSTNAME/users/octocat/orgs",
    "repos_url": "https://HOSTNAME/users/octocat/repos",
    "events_url": "https://HOSTNAME/users/octocat/events{/privacy}",
    "received_events_url": "https://HOSTNAME/users/octocat/received_events",
    "type": "User",
    "site_admin": false
  }
}