Skip to content

Link a GitHub organization or team (admin)

PUT
/v1/orgs/{org}/github
curl --request PUT \
--url https://example.com/v1/orgs/example/github \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "github_org": "example", "team": "example", "role": "viewer" }'

People who sign in with GitHub and are active members of the GitHub organization (or team) join with the given role. When they leave on GitHub, they lose access at their next GitHub sign-in. Invited members are never removed by this.

The caller must be signed in with GitHub (a browser session), and GitHub must have said at that sign-in that they are an admin of the GitHub organization; otherwise 403 github.adminRequired. The link stores the organization’s numeric ID (github_org_id) and GitHub’s spelling of its name; sign-in matches by the ID. A github_org_id in the request is ignored.

org
required
string

Organization (tenant) slug, e.g. alpenrobotik

Media typeapplication/json
object
github_org
required

GitHub organization name

string
github_org_id

GitHub’s numeric ID of the organization, set when an admin of it saves the link. Missing on links saved before verification existed: those grant nothing until an admin of the GitHub organization saves them again.

integer format: int64
team

Team slug; members of only this team get access. Empty: the whole organization.

string
role
required

Role given to people who join through GitHub (never owner)

string
Allowed values: viewer member admin

Linked

Media typeapplication/json
object
github_org
required

GitHub organization name

string
github_org_id

GitHub’s numeric ID of the organization, set when an admin of it saves the link. Missing on links saved before verification existed: those grant nothing until an admin of the GitHub organization saves them again.

integer format: int64
team

Team slug; members of only this team get access. Empty: the whole organization.

string
role
required

Role given to people who join through GitHub (never owner)

string
Allowed values: viewer member admin

Example

{
"role": "viewer"
}

Invalid organization

Caller is not an admin, or not signed in with GitHub as an admin of that GitHub organization (github.adminRequired)

Over the operation’s rate-limit budget (x-affectra-budget): code request.rateLimited with params.budget. Wait Retry-After seconds before trying again.

Media typeapplication/problem+json

Every error answer, Content-Type application/problem+json. The web app and integrations translate code; detail is English, for people reading curl output or CI logs, and may change wording at any time. Match on code, never on detail.

object
status
required

The HTTP status

integer
code
required

Stable error codes. A code is never renamed; new ones may be added, so a client falls back to detail for a code it doesn’t know. Another organization’s object answers notFound, the same as a missing one.

string
Allowed values: notFound internal request.invalidJson request.invalid request.alreadyExists request.timeInvalid auth.required auth.csrfMissing email.invalid accounts.passwordUnavailable locale.invalid request.rateLimited auth.sessionRequired auth.roleTooLow auth.githubTokenUploadOnly org.suspended org.required request.fieldRequired request.textInvalid request.timeout server.notReady catalog.unavailable report.invalid report.wrongTenant settings.csafNamespaceInvalid settings.digestHourInvalid settings.timeZoneInvalid sbom.invalid sbom.limitExceeded sbom.signatureInvalid sbom.signatureRequired sbom.signatureUnavailable upload.hardwareRevisionRenamed upload.malformed upload.unexpectedPart upload.sbomMissing upload.tooLarge upload.unreadable provenance.invalid provenance.sbomAttestation provenance.signatureRequired provenance.unavailable vex.vulnerabilityInvalid vex.statusInvalid vex.justificationUnknown vex.justificationNotAllowed vex.justificationRequired vex.actionRequired vex.statementTooLong vex.csafNamespaceRequired vex.csafNoStatements release.hasVexStatements finding.refInvalid mapping.purlInvalid mapping.purlVersioned mapping.purlCoveredByOsv mapping.cpeFieldInvalid mapping.builtIn mapping.csafProviderUnknown mapping.csafKindInvalid mapping.csafValueInvalid feeds.notSubscribable accounts.setupEmailLimit member.exists member.joined member.roleInvalid member.ownerGrantDenied member.ownerChangeDenied member.ownerRemoveDenied member.lastOwner github.orgInvalid github.teamInvalid github.roleInvalid github.adminRequired key.nameInvalid key.roleInvalid key.purposeInvalid product.keyInvalid product.keyExists product.keyLocked product.supportEndsInvalid alias.reportedInvalid alias.exists publisher.repositoryInvalid publisher.fieldTooLong publisher.idsIncomplete publisher.repositoryNotFound publisher.githubUnreachable publisher.workflowInvalid publisher.refPatternPrefix publisher.refPatternInvalid publisher.exists graph.vulnerabilityUnknown graph.timeout proposal.evidenceUnknown proposal.evidenceTooLarge proposal.kindInvalid proposal.basisInvalid proposal.notCarryOver proposal.basisMismatch proposal.notPending proposal.sourceSuperseded proposal.ownProposal proposal.fourEyes proposal.personRequired proposal.batchTooLarge proposal.vulnerabilityChanged proposal.reportedChanged proposal.releaseUnknown proposal.evidenceMissing notifications.unavailable notifications.findingsInvalid notifications.tokenInvalid webhook.urlRejected webhook.limitReached webhook.formatUnavailable webhook.headerInvalid webhook.eventTypesInvalid webhook.disabled events.cursorInvalid
detail
required

What went wrong

string
params
required

Values the code’s message needs, e.g. {“field”: “version”}. Only values the caller sent or may see. Empty when the message needs none.

object
key
additional properties
any

Example

{
"code": "notFound"
}
Retry-After
integer
>= 1

Seconds until a request would be allowed again, at least 1