Partner IAM API

Overview

The Partner IAM API is designed for organization-centric identity models. Use this group when your platform needs B2B-style tenancy, org membership, org invitations, org roles, org domains, and partner-facing access administration.

This group is especially relevant when identities must be managed in the context of organizations rather than as standalone customer accounts.

What this API group covers

The current Partner IAM API group includes:

• Organization
• Organization User Roles
• Organization Connections
• Organization Connection Group Roles
• Organization Domains
• Organization Invitations

These sections provide the building blocks for org-based identity operations across invitation, membership, domain, connection, and role models.

Available sections

Organization

Endpoints for creating, retrieving, updating, deleting, and administrating organizations themselves.

Organization User Roles

Endpoints for assigning, inspecting, or managing user role context inside organizations.

Organization Connections

Endpoints for org-linked connection configuration and connection lifecycle operations.

Organization Connection Group Roles

Endpoints for managing role models and access behavior across organization connection groups.

Organization Domains

Endpoints for attaching, retrieving, verifying, and deleting domains associated with organizations.

Organization Invitations

Endpoints for issuing, resending, updating, retrieving, and revoking organization invitations.

Common workflows

Typical uses for this group include:

• onboarding a user into an organization through invitation flows
• creating and managing organizations and their lifecycle state
• assigning org roles or cross-org user role contexts
• attaching domains to organizations for scoped identity access
• configuring partner-facing org connections and access models

When to start here

Start with the Partner IAM API when:

• your access model is organization-based
• you need B2B or partner identity administration
• users belong to orgs with org-specific roles or invitations
• domains, invitations, and org membership determine how access works

If your primary flow is consumer login or account lifecycle without organization context, start with the Authentication API or Account API instead.

Next steps

• Review the Authorization page for the service-side auth model used in this group
• Start with Organization Invitations for onboarding workflows
• Start with Organization for core org lifecycle management
• Use Organization User Roles and related sections for access control inside organizations