Skip to content
Organization Person

Organization Person

An Organization Person link represents a many-to-many relationship between a person and an organization. Creating this link associates a person with an organization. Deleting the link removes the association without affecting either the person or the organization record.

Sample Object

{
  "id": "olk_abc123def456",
  "organization_id": "org_abc123def456",
  "person_id": "ppl_abc123def456"
}

Fields

FieldTypeDescription
idstringUnique identifier for the link. Auto-generated on create.
organization_idstringID of the organization in the relationship.
person_idstringID of the person in the relationship.

Actions

Linking a person to an organization

Creates a new association between a person and an organization. The link can be created from either the person’s organizations endpoint or the organization’s people endpoint.

obx app identity:people:organizations link --person-id ppl_abc123def456 --data org.json

Listing organizations for a person

Returns all organization-person links where the person is a member. Use this to list every organization a person belongs to.

obx app identity:people:organizations list --person-id ppl_abc123def456

Listing people in an organization

Returns all organization-person links for a specific organization. Use this to list every person who belongs to the organization.

obx app identity:organizations:people list --org-id org_abc123def456

Getting an organization-person link

Returns a specific link by its ID.

obx app identity:organizations:people get olk_abc123def456 --org-id org_abc123def456

Unlinking a person from an organization

Removes the association between a person and an organization. This deletes only the link record. The person and organization remain unchanged.

obx app identity:people:organizations delete olk_abc123def456 --person-id ppl_abc123def456