Skip to content
GitmoapAPIBeta
Integrateprovider-settings
PUT/groups/{group_id}/provider-policy

Set a group's provider tier policy

set_provider_policy
  • provider_policy:manage
    A token needs the provider_policy:manage scope: Manage provider tier policyGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

    x-gitmoap-audit: {"kind":"audited","arg":"mutation"}

Decides which tiers of provider the pipelines in this group and beneath it may run: verified providers, community providers (disabled, verified_only or any), and the organization's own private providers. Platform providers are always accepted. The policy can also require that a newer version's changelog be acknowledged before a provider is upgraded to it. The body replaces the group's policy whole: a field you leave out is inherited from the groups above, unless override_parent stops the inheritance here. Answers with the policy now in effect. Owners of the group.

Parameters

Path
  • group_idGroupId (string · uuid)Group id

Request body

application/json
  • accept_communityCommunityAcceptancedisabledanyverified_onlyor nulloptionalWhether an organization's pipelines may run Community-tier providers. disabled (the default) refuses them; any admits any Community provider in the catalog; verified_only admits only those whose publisher namespace is verified.
  • accept_own_privateboolean or nulloptional
  • accept_verifiedboolean or nulloptional
  • override_parentboolean or nulloptional
  • require_changelog_ackboolean or nulloptional
Request body exampleSynthesized example
{}

Responses

200application/json
  • accept_communityCommunityAcceptancedisabledanyverified_onlyWhether an organization's pipelines may run Community-tier providers. disabled (the default) refuses them; any admits any Community provider in the catalog; verified_only admits only those whose publisher namespace is verified.
  • accept_own_privateboolean
  • accept_verifiedboolean
  • accepted_tiersarray of ProviderTier: one of platform | verified | community | privateThe provider tiers this policy accepts in some form. platform is always included.
  • inheritedboolean
  • override_parentboolean
  • require_changelog_ackbooleanWhen set, moving to a newer provider version requires acknowledging its changelog first. Off by default.
  • scope_idstringThe id of the group or repository asked about.
  • source_scope_idstring or nulloptionalThe id of the group or repository whose policy supplied these values — possibly a group above the one asked about. Absent when no policy is set anywhere and the defaults apply.
  • updated_byActorSummary or nulloptionalWho last changed the policy that supplied these values. Absent when no policy is set anywhere and the defaults apply.
200 exampleSynthesized example
{
"accept_community": "disabled",
"accept_own_private": false,
"accept_verified": false,
"accepted_tiers": [
"platform",
"platform"
],
"inherited": false,
"override_parent": false,
"require_changelog_ack": false,
"scope_id": "da74ba8f-652c-48ca-8e96-8fa18954db4a",
"source_scope_id": "45fed4c0-c426-4a1b-a86b-2f3c77894518",
"updated_by": {
"email": "lin@acme.example",
"id": "id-ff4a",
"username": "mara",
"avatar_url": "https://gitmoap.example/acme/26972c67"
}
}
400application/json
Error codes
  • BAD_REQUESTThe request is malformed: a parameter or a body field is not a well-formed value of its type
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
400 exampleSynthesized example
{
"error": {
"code": "code-0034",
"message": "Inline scalar newtypes but keep their brand"
}
}
401application/json
Error codes
  • UNAUTHORIZEDNo credential was sent, or the one sent is invalid, expired or revoked
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
401 exampleSynthesized example
{
"error": {
"code": "code-1bb1",
"message": "Label every synthesized example"
}
}
403application/json
Error codes
  • FORBIDDENYou are signed in but may not do this here; reason names the permission or the rule that refused it
  • INSUFFICIENT_SCOPEThe access token lacks the scope this operation needs; required_scope names it
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
403 exampleSynthesized example
{
"error": {
"code": "code-27c0",
"message": "Label every synthesized example"
}
}
404application/json
Error codes
  • NOT_FOUNDThe resource does not exist — or exists and you cannot see it: a private resource you have no access to answers exactly as an absent one does
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
404 exampleSynthesized example
{
"error": {
"code": "code-e5f4",
"message": "Pin a page's payload to the build that rendered it"
}
}
409The request conflicts with the resource's current state; `reason` says howapplication/json
Error codes
  • CONFLICTThe request conflicts with the resource's current state; reason says how
  • LEGAL_ACCEPTANCE_REQUIREDAccept the current Terms of Service before changing anything; reading stays open
  • errorErrorBody
    • The ErrorBody schema
    • codestringThe coarse category, tied to the status: NOT_FOUND, CONFLICT, INSUFFICIENT_SCOPE. Every error has one; the API reference's error catalogue lists them all.
    • messagestringWhat went wrong, for a person. Written to be read, not parsed: match on reason or code.
    • fieldstring or nulloptionalOn a 400 that refused one field's value, the field, as its JSON path: email, items[0].name. Put the message under that input. Absent on every other error.
    • reasonstring or nulloptionalThe specific code, when the error has one: LAST_ORGANIZATION_OWNER, BRANCH_PROTECTED. The message starts with it too. Match on this when it is present, and on code otherwise.
    • required_scopestring or nulloptionalThe scope the access token was missing, on INSUFFICIENT_SCOPE.
    • violationsanyoptionalPresent on the structured-validation errors (PROVIDER_VALIDATION_FAILED per-node, PIPELINE_VALIDATION_FAILED DAG): a JSON array of the offending elements, so a caller can fix every one in a single round-trip. Absent (omitted) on every other error.
409 exampleSynthesized example
{
"error": {
"code": "code-033e",
"message": "Label every synthesized example"
}
}

CLI

gitmoap provider-settings set-provider-policy

  • --group-ididGroup id (id or group path)
  • --accept-communitydisabled | any | verified_onlyoptional
  • --accept-own-privateflagoptional
  • --accept-verifiedflagoptional
  • --override-parentflagoptional
  • --require-changelog-ackflagoptional

Used in these guides