Skip to content
GitmoapAPIBeta
Identity & platformsso
GET/groups/{group_id}/sso-connection

Read the organization's single sign-on connection.

get_sso_connection
  • sso:read
    A token needs the sso:read scope: Read the org's SSO connection and claimed domainsGranted by read_api, write_api.Every operation this scope unlocks
  • Audited · sensitive read

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

Its protocol, status, attribute mapping, verified domains and sign-in policy, with the last setup error if there was one. Secrets are never returned, only whether an OpenID Connect client secret or a SAML metadata document is set; a disabled connection reads as disabled. Only the organization's owners can read it.

Parameters

Path
  • group_idGroupId (string · uuid)The organization's top-level group

Responses

200application/json
  • attribute_mappingSsoAttributeMapping
    • The SsoAttributeMapping schema
    • emailstringThe claim or attribute carrying the person's email address. Defaults to email.
    • groupsstring or nulloptionalThe claim listing the person's groups at the identity provider, if any. Teams linked to those groups follow it.
    • usernamestring or nulloptionalThe claim a new account's username is derived from, if any.
  • auto_provisionboolean
  • cognito_idp_nameSsoIdpName (string)The name the identity provider is registered under for sign-in.
  • created_atstring
  • default_roleRoleViewThe role newcomers are given at the top-level group.
    • The RoleView schema
    • namestringThe role's display name: a built-in name such as Developer, or the custom role's name.
    • rankAccessLevelguestreporterdevelopermaintainerownerThe built-in rank the role counts as wherever a rank is compared, such as a protected branch's minimum.
    • builtinAccessLevelguestreporterdevelopermaintainerowneror nulloptionalSet when the role is built in.
    • customRoleId (string · uuid) or nulloptionalSet when the role is one the organization defined.
  • enforcedboolean
  • idp_sync_max_age_daysinteger · int320–∞Days a place on a team linked to an identity-provider group lasts without the person signing in again.
  • protocolSsoProtocolsamloidcThe IdP protocol an org's connection speaks.
  • root_group_idGroupId (string · uuid)
  • statusSsoConnectionStatuspendingprovisioningactivefaileddisabledWhere an organization's SSO connection is in being set up. A connection left provisioning or failed is retried by saving the connection again.
  • updated_atstring
  • verified_domainsarray of Domain (string)
  • created_byActorSummary or nulloptional
  • last_provision_errorstring or nulloptional
  • oidcOidcConfigView or nulloptional
    • The OidcConfigView schema
    • client_secret_setboolean
    • scopesarray of string
    • client_idstring or nulloptional
    • issuer_urlstring or nulloptional
  • samlSamlConfigView or nulloptional
    • The SamlConfigView schema
    • metadata_xml_setbooleanWhether a SAML metadata document was supplied directly rather than by URL.
    • metadata_urlstring or nulloptional
200 exampleSynthesized example
{
"attribute_mapping": {
"email": "lin@acme.example",
"groups": "groups-ee2f",
"username": "lin"
},
"auto_provision": false,
"cognito_idp_name": "payments-api",
"created_at": "2026-10-14T05:55:11Z",
"default_role": {
"name": "payments-api",
"rank": "guest",
"builtin": "guest",
"custom": "10ab0273-af5f-4df3-890a-4f9458254723"
},
"enforced": false,
"idp_sync_max_age_days": 24,
"protocol": "saml",
"root_group_id": "4c1d8e2f-6a3b-4f90-b7c5-1e2d3c4b5a69",
"status": "active",
"updated_at": "2026-10-08T14:37:00Z",
"verified_domains": [
"verified-domains-b122",
"verified-domains-d52f"
],
"created_by": {
"email": "tomas@acme.example",
"id": "id-1c89",
"username": "lin",
"avatar_url": "https://gitmoap.example/acme/ed2bd4af"
},
"last_provision_error": "last-provision-error-6d28",
"oidc": {
"client_secret_set": false,
"scopes": [
"scopes-2a43",
"scopes-fa76"
],
"client_id": "d656034d-bdcb-4c9b-a0e8-bc3b950eaee1",
"issuer_url": "https://gitmoap.example/acme/6ba9aeef"
},
"saml": {
"metadata_xml_set": false,
"metadata_url": "https://gitmoap.example/acme/99e561b1"
}
}
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-fba2",
"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-c969",
"message": "Stream pipeline status into the run header"
}
}
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-fb19",
"message": "Draw the region map from operation density"
}
}
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-bc4b",
"message": "Label every synthesized example"
}
}

CLI

gitmoap sso get-sso-connection

  • --group-ididThe organization's top-level group (id or group path)

Used in these guides