People and access¶
Use the linked wire models for field constraints. Operation metadata does not enumerate every possible HTTP error or replace current server authorization.
On this page¶
- Members (GET)
- Member create (POST)
- Member patch (PATCH)
- Member delete (DELETE)
- Invitations list (GET)
- Invitation create (POST)
- Invitation revoke (DELETE)
- Invitation inspect (POST)
- Invitation redeem (POST)
- Self (GET)
- Page (GET)
- Create (POST)
- Get (GET)
- Update (PATCH)
- Avatar (GET)
- Reports (GET)
- Units (GET)
- Create unit (POST)
- Update unit (PATCH)
- Delete unit (DELETE)
- Settings (GET)
- Update settings (PATCH)
- Mapping (GET)
- Update mapping (PUT)
Members¶
GET /api/v1/tenants/{tenant_id}/members
Contract operation: MembershipController.members.
| SDK | Method |
|---|---|
| Python | members |
| TypeScript | members.list |
| Java | client.members.list |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
q |
query | QueryParam[str] |
No | "" |
role |
query | QueryParam[str | None] |
No | null |
scope |
query | QueryParam[str] |
No | "all" |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Page[Membership] |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Member create¶
POST /api/v1/tenants/{tenant_id}/members
Contract operation: MembershipController.member_create.
| SDK | Method |
|---|---|
| Python | add_member |
| TypeScript | members.add |
| Java | client.members.add |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[MemberCreate]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | MemberInput |
| Response schema | Membership |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Member patch¶
PATCH /api/v1/tenants/{tenant_id}/members/{member_id}
Contract operation: MembershipController.member_patch.
| SDK | Method |
|---|---|
| Python | update_member |
| TypeScript | members.update |
| Java | client.members.update |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
member_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[MemberPatch]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | MemberUpdate |
| Response schema | Membership |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Member delete¶
DELETE /api/v1/tenants/{tenant_id}/members/{member_id}
Contract operation: MembershipController.member_delete.
| SDK | Method |
|---|---|
| Python | remove_member |
| TypeScript | members.remove |
| Java | client.members.remove |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
member_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | No response body |
| Success status | 204 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Invitations list¶
GET /api/v1/tenants/{tenant_id}/invitations
Contract operation: MembershipController.invitations_list.
| SDK | Method |
|---|---|
| Python | invitations |
| TypeScript | invitations.list |
| Java | client.invitations.list |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
status |
query | QueryParam[str] |
No | "pending" |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | Page[Invitation] |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Invitation create¶
POST /api/v1/tenants/{tenant_id}/invitations
Contract operation: MembershipController.invitation_create.
| SDK | Method |
|---|---|
| Python | create_invitation |
| TypeScript | invitations.create |
| Java | client.invitations.create |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[InvitationInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | InvitationInput |
| Response schema | InvitationCreated |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Invitation revoke¶
DELETE /api/v1/tenants/{tenant_id}/invitations/{invitation_id}
Contract operation: MembershipController.invitation_revoke.
| SDK | Method |
|---|---|
| Python | revoke_invitation |
| TypeScript | invitations.revoke |
| Java | client.invitations.revoke |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
invitation_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | No response body |
| Success status | 204 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Invitation inspect¶
POST /api/v1/invitations/inspect
Contract operation: MembershipController.invitation_inspect.
| SDK | Method |
|---|---|
| Python | inspect_invitation |
| TypeScript | invitations.inspect |
| Java | client.invitationAccess.inspect |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
body |
body | Valid[Body[InvitationToken]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | InvitationToken |
| Response schema | InvitationPreview |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Invitation redeem¶
POST /api/v1/invitations/redeem
Contract operation: MembershipController.invitation_redeem.
| SDK | Method |
|---|---|
| Python | redeem_invitation |
| TypeScript | invitations.redeem |
| Java | client.invitationAccess.redeem |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
body |
body | Valid[Body[InvitationToken]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | InvitationToken |
| Response schema | Membership |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Self¶
GET /api/v1/tenants/{tenant_id}/organization/people/me
Contract operation: OrganizationPeopleController.self.
| SDK | Method |
|---|---|
| Python | organization_person_self |
| TypeScript | organizationPeople.me |
| Java | client.organizationPeople.me |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationPerson |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Page¶
GET /api/v1/tenants/{tenant_id}/organization/people
Contract operation: OrganizationPeopleController.page.
| SDK | Method |
|---|---|
| Python | organization_people |
| TypeScript | organizationPeople.list |
| Java | client.organizationPeople.list |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
q |
query | QueryParam[str] |
No | "" |
job_title |
query | QueryParam[str] |
No | "" |
unit_id |
query | QueryParam[str | None] |
No | null |
department_id |
query | QueryParam[str | None] |
No | null |
manager_id |
query | QueryParam[str | None] |
No | null |
unassigned |
query | QueryParam[bool] |
No | false |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationPersonPage |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Create¶
POST /api/v1/tenants/{tenant_id}/organization/people
Contract operation: OrganizationPeopleController.create.
| SDK | Method |
|---|---|
| Python | create_organization_person |
| TypeScript | organizationPeople.create |
| Java | client.organizationPeople.create |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[OrganizationPersonCreate]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | OrganizationPersonCreate |
| Response schema | OrganizationPerson |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Get¶
GET /api/v1/tenants/{tenant_id}/organization/people/{person_id}
Contract operation: OrganizationPeopleController.get.
| SDK | Method |
|---|---|
| Python | organization_person |
| TypeScript | organizationPeople.get |
| Java | client.organizationPeople.get |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
person_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationPerson |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Update¶
PATCH /api/v1/tenants/{tenant_id}/organization/people/{person_id}
Contract operation: OrganizationPeopleController.update.
| SDK | Method |
|---|---|
| Python | update_organization_person |
| TypeScript | organizationPeople.update |
| Java | client.organizationPeople.update |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
person_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[OrganizationPersonPatch]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | OrganizationPersonPatch |
| Response schema | OrganizationPerson |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Avatar¶
GET /api/v1/tenants/{tenant_id}/organization/people/{person_id}/avatar
Contract operation: OrganizationPeopleController.avatar.
| SDK | Method |
|---|---|
| Python | organization_person_avatar |
| TypeScript | organizationPeople.avatar |
| Java | client.organizationPeople.avatar |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
person_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | BinaryDownload |
| Success status | 200 |
| Declared encoding | binary |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
If-None-Match (optional; avatars only)
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Reports¶
GET /api/v1/tenants/{tenant_id}/organization/people/{person_id}/reports
Contract operation: OrganizationPeopleController.reports.
| SDK | Method |
|---|---|
| Python | organization_person_reports |
| TypeScript | organizationPeople.reports |
| Java | client.organizationPeople.reports |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
person_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationPersonPage |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Units¶
GET /api/v1/tenants/{tenant_id}/organization/units
Contract operation: OrganizationPeopleController.units.
| SDK | Method |
|---|---|
| Python | organization_units |
| TypeScript | organizationPeople.units |
| Java | client.organizationPeople.units |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
workspace_id |
query | QueryParam[str | None] |
No | null |
parent_id |
query | QueryParam[str | None] |
No | null |
q |
query | QueryParam[str] |
No | "" |
page |
query | QueryParam[int] |
No | 1 |
page_size |
query | QueryParam[int] |
No | 25 |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationUnitPage |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Create unit¶
POST /api/v1/tenants/{tenant_id}/organization/units
Contract operation: OrganizationPeopleController.create_unit.
| SDK | Method |
|---|---|
| Python | create_organization_unit |
| TypeScript | organizationPeople.createUnit |
| Java | client.organizationPeople.createUnit |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[OrganizationUnitInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | OrganizationUnitInput |
| Response schema | OrganizationUnit |
| Success status | 201 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Update unit¶
PATCH /api/v1/tenants/{tenant_id}/organization/units/{unit_id}
Contract operation: OrganizationPeopleController.update_unit.
| SDK | Method |
|---|---|
| Python | update_organization_unit |
| TypeScript | organizationPeople.updateUnit |
| Java | client.organizationPeople.updateUnit |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
unit_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[OrganizationUnitPatch]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | OrganizationUnitPatch |
| Response schema | OrganizationUnit |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Delete unit¶
DELETE /api/v1/tenants/{tenant_id}/organization/units/{unit_id}
Contract operation: OrganizationPeopleController.delete_unit.
| SDK | Method |
|---|---|
| Python | delete_organization_unit |
| TypeScript | organizationPeople.deleteUnit |
| Java | client.organizationPeople.deleteUnit |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
unit_id |
path | PathVar[str] |
Yes | Not specified |
expected_revision |
query | QueryParam[int] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | No response body |
| Success status | 204 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Settings¶
GET /api/v1/tenants/{tenant_id}/organization/directory-settings
Contract operation: OrganizationPeopleController.settings.
| SDK | Method |
|---|---|
| Python | organization_directory_settings |
| TypeScript | organizationPeople.settings |
| Java | client.organizationPeople.settings |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationDirectorySettings |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Update settings¶
PATCH /api/v1/tenants/{tenant_id}/organization/directory-settings
Contract operation: OrganizationPeopleController.update_settings.
| SDK | Method |
|---|---|
| Python | update_organization_directory_settings |
| TypeScript | organizationPeople.updateSettings |
| Java | client.organizationPeople.updateSettings |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[OrganizationDirectorySettingsInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | OrganizationDirectorySettingsInput |
| Response schema | OrganizationDirectorySettings |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Mapping¶
GET /api/v1/tenants/{tenant_id}/organization/profile-mappings/{provider_id}
Contract operation: OrganizationPeopleController.mapping.
| SDK | Method |
|---|---|
| Python | organization_profile_mapping |
| TypeScript | organizationPeople.mapping |
| Java | client.organizationPeople.mapping |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
provider_id |
path | PathVar[str] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | No request schema declared |
| Response schema | OrganizationProfileMapping |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.
Update mapping¶
PUT /api/v1/tenants/{tenant_id}/organization/profile-mappings/{provider_id}
Contract operation: OrganizationPeopleController.update_mapping.
| SDK | Method |
|---|---|
| Python | update_organization_profile_mapping |
| TypeScript | organizationPeople.updateMapping |
| Java | client.organizationPeople.updateMapping |
Parameters¶
These are the declared path, query and body arguments. Multipart and binary inputs are described by their request schema below. SDK argument names may follow each language’s conventions.
| Name | Location | Declared type | Required | Default |
|---|---|---|---|---|
tenant_id |
path | PathVar[str] |
Yes | Not specified |
provider_id |
path | PathVar[str] |
Yes | Not specified |
body |
body | Valid[Body[OrganizationProfileMappingInput]] |
Yes | Not specified |
Request and response¶
| Contract | Value |
|---|---|
| Request schema | OrganizationProfileMappingInput |
| Response schema | OrganizationProfileMapping |
| Success status | 200 |
| Declared encoding | application/json |
Encoding identifies the upload, stream or download format when applicable; otherwise it is JSON. It is not a declaration that a GET request has a body.
Headers¶
No operation-specific headers are declared in the canonical metadata.
Authentication and resource bounds still apply. See request behavior and the SDK runtime reference.