指定したユーザーを更新
patch
/social/api/v1/people/{peopleID}
リクエスト
サポートされているメディア・タイプ
- application/json
パス・パラメータ
- peopleID: integer(int64)
人ID。 オブジェクトのlong integer表現の一意識別子。
リクエスト本文は、リクエストの詳細を定義します。
ルート・スキーマ: XV1PeopleUpdateInfo
型:
objectV1人更新情報。
Show Source
- profileUpdater(optional): object XUserProfileUpdater
ユーザー・プロファイルのアップデータ。
- updater(optional): object XUserUpdater
ユーザー・オブジェクトのアップデータ。
重要: 次のアップデータ・フィールドはXUserModule.Server.updateUser()メソッドでのみサポートされています。 XUserObject.updateAttributes()メソッドではサポートされません。 XUserObjectクライアントは、かわりに個別のセッター(setAdmin()、setEnabled()などを参照)を呼び出す必要があります。
XUpdaterを使用して更新できる追加のユーザー関連フィールド(役職、電話番号など)の詳細は、XUserProfileUpdaterを参照してください。
ネストされたスキーマ: XUserProfileUpdater
型:
objectユーザー・プロファイルのアップデータ。
Show Source
- AddressBuilding(optional): string
ユーザーの住所の建物の文字列。
- AddressCity(optional): string
ユーザーの住所の市区の文字列。
- AddressCountry(optional): string
ユーザーの住所の国の文字列。
- AddressLine1(optional): string
ユーザーの住所1の文字列。
- AddressLine2(optional): string
ユーザーの住所2の文字列。
- AddressOffice(optional): string
ユーザーの住所のオフィスの文字列。
- AddressState(optional): string
ユーザーの住所の都道府県の文字列。
- AddressZipCode(optional): string
ユーザー・アドレスのZIPコードの文字列。
- Altitude(optional): string
高度のdouble値。
- Biography(optional): string
ユーザーの履歴の文字列。
- Color(optional): string
ユーザーの色。
- Company(optional): string
ユーザーの会社の文字列。
- CostCenter(optional): string
ユーザーのコスト・センターの文字列。
- CustomFields(optional): string
すべてのカスタム・フィールドのコレクション。
- DateFormatLocale(optional): string
ユーザーの日付書式ロケール。
- Description(optional): string
ユーザーの説明の文字列。
- EMailAddress(optional): string
ユーザーの電子メール・アドレス。
- Expertise(optional): string
ユーザーの専門知識の文字列。
- fMap(optional): string
含まれるマップ(文字列から値)。
- FullName(optional): string
ユーザーのフルネーム('John Doe'など)。 これを使用してDisplayName値を生成できます。
- Interests(optional): string
ユーザーの興味の文字列。
- LanguageLocale(optional): string
ユーザーのロケール。
- Latitude(optional): string
緯度のdouble値。
- Link(optional): string
名前(文字列)をリンク(文字列)とするすべてのリンクのマップ。
- Links(optional): string
名前(文字列)をリンク(文字列)とするすべてのリンクのマップ。
- Location(optional): string
ユーザーのロケーションの文字列。
- Locations(optional): string
名前(文字列)を持つすべてのリンクのタイムゾーン(TimeZone)へのマップ。
- Longitude(optional): string
経度のdouble値。
- Manager(optional): string
ユーザーのマネージャ。
- OfflineStatusMessage(optional): string
ユーザーのオフライン・ステータス・メッセージ。
- OnlineStatusMessage(optional): string
ユーザーのオンライン・ステータス・メッセージ。
- Organization(optional): string
ユーザーの組織の文字列。
- PhoneNumber(optional): string
このユーザーの電話番号。 これまたはPHONE_NUMBERSを使用し、両方は使用しないでください。 それはすべての電話番号を置き換えます。 このフィールドは、LDAP同期およびユーザーの作成コードからのみ使用されます。 このフィールドによって、すべての電話番号が1つの番号に設定されます。 このフィールドは特別な目的がないかぎり使用されません。
- PhoneNumbers(optional): string
すべての電話番号のXUserPhoneNumberInfoのコレクション。 これまたはPHONE_NUMBERを使用し、両方は使用しないでください。 それはすべての電話番号を置き換えます。 すべての電話番号を変更するために使用する正しいフィールドです。
- RTCServers(optional): string
RTCサーバー。 このフィールドの型はXUserRTCServerInfoオブジェクトのリストです。
- ShowMembershipMessagesDefault(optional): string
このユーザーが入力した会話のデフォルトのメンバーシップ・メッセージ・ステータスを示すブール値。
- SMSAddress(optional): string
このユーザーのSMSアドレス。
- SocialObjectViewID(optional): string
コラボレーション・オブジェクトのビューID。
- Status(optional): string
ユーザーのステータスの文字列。
- Tags(optional): string
追加する(文字列)タグを含むコレクション。
- TimeZone(optional): string
ユーザーのデフォルトのタイムゾーン。
- Title(optional): string
ユーザーの役職の文字列。
ネストされたスキーマ: XUserUpdater
型:
objectユーザー・オブジェクトのアップデータ。
Show Source
重要: 次のアップデータ・フィールドはXUserModule.Server.updateUser()メソッドでのみサポートされています。 XUserObject.updateAttributes()メソッドではサポートされません。 XUserObjectクライアントは、かわりに個別のセッター(setAdmin()、setEnabled()などを参照)を呼び出す必要があります。
XUpdaterを使用して更新できる追加のユーザー関連フィールド(役職、電話番号など)の詳細は、XUserProfileUpdaterを参照してください。
- ActOnBehalfOf(optional): string
代理操作ステータスのboolean値。
- Admin(optional): string
サイト管理者ステータスのboolean値。
- AppAuthor(optional): string
アプリケーション作成者ステータスのブール値。
- AppID(optional): string
アプリケーションIDステータスのブール値。
- Bypass(optional): string
バイパス・ステータスのboolean値。
- CanCreateConversation(optional): string
ユーザーが会話を作成できるかどうかのboolean値。
- CanDiscover(optional): string
ユーザーが検出を実行できるかどうかのboolean値。
- CECEnterpriseExternalUser(optional): string
CECEnterpriseExternalUserステータスのブール。
- CECExternalUser(optional): string
CECExternalUserステータスのブール。
- ClientAPP(optional): string
クライアント・アプリケーション・ステータスのブール値。
- Deleted(optional): string
削除ステータスのboolean値。
- Developer(optional): string
開発者ステータスのboolean値。
- Enabled(optional): string
有効ステータスのboolean値。
- ExtendedRetention(optional): string
このユーザーが拡張保持ポリシーを使用しているかどうかのboolean値。
- fMap(optional): string
含まれるマップ(文字列から値)。
- Guest(optional): string
ゲスト・ステータスのboolean値。
- Hidden(optional): string
非表示ステータスのboolean値。
- IntegrationUser(optional): string
統合ステータスのブール値。
- Internal(optional): string
内部レルム権限のブール値(外部構成レルムと比較して)。
- IsOnLegalHold(optional): string
リーガル・ホールドのboolean値。
- LegalDiscoverer(optional): string
法的な開示者ステータスのboolean値。
- Locked(optional): string
ロック・ステータスのboolean値。
- MailImporterID(optional): string
メール・インポータIDのロング。
- Name(optional): string
名前の文字列。
- Outsider(optional): string
部外者ステータスのboolean値。
- RealmData(optional): string
レルム・データの文字列。
- RealmUID(optional): string
レルムの一意IDの文字列。
- Restricted(optional): string
制限付きステータスのboolean値。
- Tenant(optional): string
テナント管理者ステータスのboolean値。
- Verified(optional): string
ユーザーが検証済であるかどうかのboolean値。
レスポンス
サポートされているメディア・タイプ
- application/json
200レスポンス
操作の成功
ルート・スキーマ: XV1PeopleInfo
型:
objectV1人情報DTO。
Show Source
- addressBuilding(optional): string
このユーザー・ビルディング。
- addressCity(optional): string
このユーザー都市。
- addressCountry(optional): string
このユーザー国。
- addressLine1(optional): string
このユーザーの番地は1行目です。
- addressLine2(optional): string
このユーザーの番地は2行目です。
- addressOffice(optional): string
このユーザー・オフィス。
- addressState(optional): string
このユーザー状態。
- addressZipCode(optional): string
このユーザーの郵便番号。
- altitude(optional): number(double)
オブジェクトの高度。
- biography(optional): string
このユーザーの履歴。
- chatURL(optional): string(url)
このユーザーの、現在のユーザーとの1対1の会話を指定するURL。
- collectionURL(optional): string(url)
コレクションを含むこのオブジェクトのURLです。
- company(optional): string
このユーザーの会社。
- conversationURL(optional): string(url)
このオブジェクトに含まれる会話へのURL。
- costCenter(optional): string
このユーザーのコスト・センター。
- createdByID(optional):
オブジェクトのlong integer表現の一意識別子。
- createdByURL(optional): string(url)
このオブジェクトを作成したユーザーへのURL。
- createdByUserDisplayName(optional): string
このオブジェクトを作成したユーザーの表示名。
- createdByUserName(optional): string
このオブジェクトを作成したユーザーの名前。
- createdDate(optional): string(date)
このオブジェクトが作成された日付。
- createdDateInISO8601Format(optional): string
このオブジェクトが作成された日付(ISO 8601書式)。
- dateFormatLocale(optional): string(uuid)
日付の書式を設定するための、このユーザーのロケール。
- description(optional): string
ユーザー・プロファイルの説明。
- displayName(optional): string
このオブジェクトの表示名。
- eMailAddress(optional): string
このユーザーの電子メール・アドレス。
- expertise(optional): string
このユーザーの専門知識。
- followersURL(optional): string(url)
このユーザーのフォロワのURL。 このユーザーのフォロワであるユーザー。
- followingURL(optional): string(url)
このユーザーがフォローしているURL。 このユーザーがフォローしているユーザー。
- fullName(optional): string
このユーザーのフルネーム。
- id(optional):
オブジェクトのlong integer表現の一意識別子。
- interests(optional): string
このユーザーの興味。
- isDeleted(optional): boolean
このユーザーが削除された場合はTrue。
- isEnabled(optional): boolean
このユーザーが有効な場合はTrue。
- isExternalUser(optional): boolean
ユーザーが外部ユーザーであれば真。
- isHidden(optional): boolean
ユーザーが非表示になる場合はTrue。
- isIntegrationUser(optional): boolean
ユーザーが統合ユーザーである場合はTrue。
- isInternal(optional): boolean
内部ユーザーの場合はTrue、外部ユーザーの場合はfalse。
- isOutsider(optional): boolean
ユーザーが部外者である場合はTrue。
- isRemoved(optional): boolean
このメッセージが削除された場合はTrue。
- languageLocale(optional): string(uuid)
このユーザーの言語ロケール。
- lastConnectedDate(optional): string(date)
このユーザーが最後に接続した日付。
- lastConnectedDateInISO8601Format(optional): string
このユーザーが最後に接続した日付(ISO 8601書式)。
- lastDisconnectedDate(optional): string(date)
このユーザーが最後に切断した日付。
- lastDisconnectedDateInISO8601Format(optional): string
このユーザーが最後に切断した日付(ISO 8601書式)。
- latitude(optional): number(double)
オブジェクトの緯度。
- libraryURL(optional): string(url)
このユーザーのライブラリを指定するURL。
- link(optional): string
このユーザーがウォールまたはプロファイルに表示しているリンクがある場合は、そのURL。
- location(optional): string
このユーザーのロケーション。
- longitude(optional): number(double)
オブジェクトの経度。
- modifiedByID(optional):
オブジェクトのlong integer表現の一意識別子。
- modifiedByURL(optional): string(url)
このオブジェクトを最後に変更したユーザーへのURL。
- modifiedByUserDisplayName(optional): string
このオブジェクトを最後に変更したユーザーの表示名。
- modifiedByUserName(optional): string
このオブジェクトを最後に変更したユーザーの名前。
- modifiedDate(optional): string(date)
このオブジェクトが最後に変更された日付。
- modifiedDateInISO8601Format(optional): string
このオブジェクトが最後に変更された日付(ISO 8601書式)。
- name(optional): string
このオブジェクトの名前。
- objectType(optional): string
このオブジェクトのタイプ。
- organization(optional): string
このユーザーの組織。
- originalPictureURL(optional): string(url)
元のピクチャのURL。
- profilePictureURL(optional): string(url)
プロファイル・ピクチャのURL (150×150ピクセル)。
- propertiesURL(optional): string(url)
このユーザーのプロパティのURL。
- removedByID(optional):
オブジェクトのlong integer表現の一意識別子。
- removedByURL(optional): string(url)
このオブジェクトを最後に削除したユーザーへのURL。
- removedByUserDisplayName(optional): string
このオブジェクトを最後に削除したユーザーの表示名。
- removedByUserName(optional): string
このオブジェクトを最後に削除したユーザーの名前。
- removedDate(optional): string(date)
このオブジェクトが削除された日付。
- removedDateInISO8601Format(optional): string
このオブジェクトが削除された日付(ISO 8601書式)。
- scaledPictureURL(optional): string(url)
スケール調整済ピクチャのURL (44×44ピクセル)。
- socialObjectURL(optional): string(url)
このオブジェクトの格納されているコラボレーション・オブジェクトへのURL。
- socialObjectViewID(optional): string
ユーザーの現在のコラボレーション・オブジェクト・ビューID(nullでもかまいません)。
- statisticsURL(optional): string(url)
このユーザーの統計を取得するためのURL。
- timeZone(optional): string(uuid)
このユーザーのタイムゾーン。
- title(optional): string
このユーザーの役職。
- url(optional): string(url)
このオブジェクトへのURL。
- wallURL(optional): string(url)
このユーザーのウォールを指定するURL。