Skip to content
GitmoapAPIBeta
Integrateprovider-settings
GET/groups/{group_id}/providers

List the providers in effect at a group

list_group_providers
  • provider_settings:read
    A token needs the provider_settings:read scope: View effective provider settingsGranted by read_api, write_api.Every operation this scope unlocks
  • Filtered across resources

    x-gitmoap-isolation: {"kind":"cross_resource_filtered"}

Every provider set at this group or a group above it, as the nearest setting decides: whether it is enabled, the version pinned and the versions allowed, whether it follows the latest version and a newer one is published, and whether the organization's policy accepts its tier. Each entry says where it was set; for a setting made at a group you cannot see, who made it and where are withheld. Anyone who can see the group; on a public group that includes callers who are not signed in.

Parameters

Path
  • group_idGroupId (string · uuid)Group id

Responses

200application/json
  • itemsarray of EffectiveProviderSettings
    • The EffectiveProviderSettings schema
    • allowed_versionsVersionPolicy
    • enabledboolean
    • inheritedboolean
    • override_parentboolean
    • provider_idProviderId (string)
    • provider_tierProviderTierplatformverifiedcommunityprivateHow a pipeline provider is distributed and how much it is vouched for.
    • publisher_verifiedbooleanWhether the owning publisher's namespace is verified.
    • source_scope_idstring
    • source_scope_typeScopeTypegrouprepository
    • tier_acceptedbooleanWhether the provider's tier is accepted by the resolved per-org policy.
    • track_latestbooleanWhether this install tracks the provider's latest published version. When true, an unpinned node resolves to latest_version at trigger.
    • update_availablebooleanWhether a newer version than the install's default_version is published — a pure semver compare that never mutates the install (D5 K6).
    • default_versionProviderVersion (string) or nulloptional
    • installed_atstring or nulloptional
    • installed_byActorSummary or nulloptional
    • latest_lifecycle_stateVersionLifecycleactivedeprecatedsunsetor nulloptionalLifecycle of latest_version, so the UI can warn on a deprecated latest. None when not resolved (the trigger-validator path leaves it None).
    • latest_versionProviderVersion (string) or nulloptionalThe provider's catalog latest_version (excludes sunset; D3).
    • owning_group_idGroupId (string · uuid) or nulloptionalThe owning org (root group) of a Private provider; None for public tiers. Used by the trigger-time tier gate (own-org vs foreign-org private).
200 exampleSynthesized example
{
"items": [
{
"allowed_versions": {
"kind": "any_published"
},
"enabled": true,
"inherited": false,
"override_parent": false,
"provider_id": "9f42cece-f9e6-42a5-8e22-b0d71ab02d39",
"provider_tier": "platform",
"publisher_verified": false,
"source_scope_id": "2d85753b-7e1e-496a-8e98-2c62c81c5aea",
"source_scope_type": "group",
"tier_accepted": false,
"track_latest": false,
"update_available": false
}
]
}
400Bad request — a path parameter is not a well-formed value of its typeapplication/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-355e",
"message": "Pin a page's payload to the build that rendered it"
}
}
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-af60",
"message": "Inline scalar newtypes but keep their brand"
}
}
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-a762",
"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-15ec",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap provider-settings list-group-providers

  • --group-ididGroup id (id or group path)

Used in these guides