Skip to content
GitmoapAPIBeta
Integrateprovider-publishing
POST/publishers

Register a publisher bound to the calling identity, claiming a namespace.

register_publisher
  • publisher:manage
    A token needs the publisher:manage scope: Register, update and verify own publisherGranted by write_api.Every operation this scope unlocks
  • Audited · mutation

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

  • Quota · publishers per owner

    x-gitmoap-quota: {"kind":"enforced","arg":"publishers_per_owner"}

A publisher is the identity providers are published under, and its namespace prefixes the id of every provider it publishes. Namespaces are first come, first served, and well-known names and brands are reserved. Your account needs a verified email address, and an account owns at most one publisher. A new publisher is active but not verified; verification, which the verified tier needs, comes from a namespace ownership challenge or a platform administrator.

Request body

application/json
  • contact_emailEmail (string)
  • display_namestring
  • namespacePublisherNamespace (string)
  • public_keystring or nulloptional
Request body exampleSynthesized example
{
"contact_email": "lin@acme.example",
"display_name": "Lin Park",
"namespace": "namespace-b9d5"
}

Responses

201application/json
  • contact_emailEmail (string)
  • created_atstring
  • display_namestring
  • namespacePublisherNamespace (string)
  • publisher_idPublisherId (string · uuid)
  • statusPublisherStatusactivesuspendedAccount status of a Publisher. Active publishers may submit; Suspended is a platform-admin hold.
  • updated_atstring
  • verifiedboolean
  • ownerActorSummary or nulloptional
  • public_keystring or nulloptional
  • verification_methodVerificationMethodmanualdnsgithubor nulloptionalHow a publisher's verified flag was earned. Manual is the platform-admin grant (D3); Dns / Github are the self-service namespace-ownership proofs.
  • verification_targetstring or nulloptional
  • verified_atstring or nulloptional
201 exampleSynthesized example
{
"contact_email": "tomas@acme.example",
"created_at": "2026-10-16T10:30:14Z",
"display_name": "Mara Okafor",
"namespace": "namespace-9ce5",
"publisher_id": "07283b79-2219-4cae-a0ec-ebd910350d72",
"status": "active",
"updated_at": "2026-10-13T22:16:43Z",
"verified": false,
"owner": {
"email": "tomas@acme.example",
"id": "id-776e",
"username": "mara",
"avatar_url": "https://gitmoap.example/acme/1e86ed59"
},
"public_key": "public-key-f372",
"verification_method": "manual",
"verification_target": "verification-target-c7eb",
"verified_at": "2026-10-09T02:11:47Z"
}
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-3103",
"message": "Label every synthesized example"
}
}
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-f554",
"message": "Draw the region map from operation density"
}
}
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
  • NAME_RESEMBLES_RESERVEDThe name looks like a name reserved for another organization; prove that organization's domain, or choose another name
  • PERMISSION_REQUIREDYou need a permission you do not hold here; the message names it
  • RESERVED_NAMESPACEThe name is reserved — for the platform, or for the organization that owns the domain the message names
  • 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-2809",
"message": "Inline scalar newtypes but keep their brand"
}
}
409application/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-c113",
"message": "Label every synthesized example"
}
}
429Publisher limit reached for this ownerapplication/json
Error codes
  • TOO_MANY_REQUESTSRetryableA quota, a rate limit or a transfer budget is spent. When the response carries Retry-After, retry after that many seconds
  • 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.
429 exampleSynthesized example
{
"error": {
"code": "code-6b6b",
"message": "Draw the region map from operation density"
}
}

CLI

gitmoap provider-publishing register-publisher

  • --contact-emailstring
  • --display-namestring
  • --namespacestring
  • --public-keystringoptional

Used in these guides