For the complete documentation index, see llms.txt. This page is also available as Markdown.

Organizations

API for managing child organizations of a channel partner

/orgs

post

Registers a new child organization under the channel partner. Creates the organization, sets up user memberships, and establishes the partnership relationship.

Path parameters
partner_org_idstring · uuidRequired
Body
namestring · min: 1 · max: 255Required

Name of the child organization. At most 255 characters, and unique across all Archera organizations; a name already in use returns 409. The stored name gains a ' c/o ' suffix, which also counts towards the 255-character limit.

labra_subscription_idstringOptional
domainstring · nullableOptional
aws_marketplace_offer_linkstring · nullableOptional
azure_marketplace_offer_linkstring · nullableOptional
gcp_marketplace_offer_linkstring · nullableOptional
Responses
200

OK

application/json
idstringRead-onlyRequired
namestringRead-onlyRequired
domainstring · nullableRead-onlyOptional
aws_marketplace_offer_linkstring · nullableRead-onlyOptional
azure_marketplace_offer_linkstring · nullableRead-onlyOptional
gcp_marketplace_offer_linkstring · nullableRead-onlyOptional
post/v2/partners/{partner_org_id}/orgs
POST /v2/partners/{partner_org_id}/orgs HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 322

{
  "name": "text",
  "labra_subscription_id": "text",
  "users": [
    {
      "email": "name@gmail.com",
      "role": "user"
    }
  ],
  "domain": null,
  "primary_address": {
    "line1": "text",
    "line2": null,
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "aws_marketplace_offer_link": null,
  "azure_marketplace_offer_link": null,
  "gcp_marketplace_offer_link": null
}
{
  "id": "text",
  "name": "text",
  "memberships": [
    {
      "role": "user",
      "username": "name@gmail.com"
    }
  ],
  "domain": null,
  "primary_address": {
    "line1": "text",
    "line2": null,
    "city": "text",
    "state": "text",
    "zip": "text",
    "country": "text"
  },
  "aws_marketplace_offer_link": null,
  "azure_marketplace_offer_link": null,
  "gcp_marketplace_offer_link": null
}

/orgs/{child_org_id}/invites

post

Invites users to the channel partner organization. Sends email invitations to the specified user emails with roles of user, admin, support, cloud_rep, restricted_user.

Path parameters
partner_org_idstring · uuidRequired
child_org_idstring · uuidRequired
Body
Responses
200

OK

application/json
rolestring · enumRead-onlyOptionalPossible values:
usernamestring · email · max: 255Read-onlyOptional
post/v2/partners/{partner_org_id}/orgs/{child_org_id}/invites
POST /v2/partners/{partner_org_id}/orgs/{child_org_id}/invites HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "users": [
    {
      "email": "name@gmail.com",
      "role": "user"
    }
  ]
}
[
  {
    "role": "user",
    "username": "name@gmail.com"
  }
]

Last updated

Was this helpful?