ポータルにメンバーを追加します
/v1/portal/portals/{portalId}/members
メンバー(userId
およびrole
)を追加するための必須パラメータは次のとおりです。
リクエスト
- portalId: string
ポータルの短縮ID。
object
- created(optional): string(date-time)
- creator(optional): string
- currentVersionId(optional): string
- description(optional): string
- documentRef(optional): string
- groupSpaceType(optional): boolean
- id(optional): string
- isGroup(optional): boolean
- link(optional): array link
- linkStates(optional): array linkStates
- locale(optional): object Locale
- modified(optional): string(date-time)
- modifier(optional): string
- name(optional): string
- namespace(optional): string
- newVersionId(optional): string
- permissionAction(optional): string
- permissionName(optional): string
- resourceType(optional): string
- role: string
ポータル・メンバーに割り当てるロールの名前。
- securityId(optional): string
- shortId(optional): string
ポータルのID。
- spaceId(optional): string
- userGUID(optional): string
- userId: string
ポータル・メンバーの名前。例: karen。
object
- country(optional): string
- displayCountry(optional): string
- displayLanguage(optional): string
- displayName(optional): string
- displayScript(optional): string
- displayVariant(optional): string
- iSO3Country(optional): string
- iSO3Language(optional): string
- language(optional): string
- script(optional): string
- unicodeLocaleAttributes(optional): array unicodeLocaleAttributes
- unicodeLocaleKeys(optional): array unicodeLocaleKeys
- variant(optional): string
object
- accessible(optional): boolean
- annotatedExceptionTypes(optional): array annotatedExceptionTypes
- annotatedParameterTypes(optional): array annotatedParameterTypes
- annotatedReceiverType(optional): object reflect.AnnotatedType
- annotatedReturnType(optional): object reflect.AnnotatedType
- bridge(optional): boolean
- default(optional): boolean
- defaultValue(optional): integer
- genericExceptionTypes(optional): array genericExceptionTypes
- genericParameterTypes(optional): array genericParameterTypes
- genericReturnType(optional): object reflect.Type
- modifiers(optional): integer(int32)
- name(optional): string
- parameterCount(optional): integer(int32)
- parameters(optional): array parameters
- synthetic(optional): boolean
- typeParameters(optional): array typeParameters
- varArgs(optional): boolean
object
- annotatedType(optional): object reflect.AnnotatedType
- declaringExecutable(optional): object reflect.Executable
- implicit(optional): boolean
- modifiers(optional): integer(int32)
- name(optional): string
- namePresent(optional): boolean
- parameterizedType(optional): object reflect.Type
- synthetic(optional): boolean
- varArgs(optional): boolean
object
- accessible(optional): boolean
- annotatedExceptionTypes(optional): array annotatedExceptionTypes
- annotatedParameterTypes(optional): array annotatedParameterTypes
- annotatedReceiverType(optional): object reflect.AnnotatedType
- annotatedReturnType(optional): object reflect.AnnotatedType
- genericExceptionTypes(optional): array genericExceptionTypes
- genericParameterTypes(optional): array genericParameterTypes
- modifiers(optional): integer(int32)
- name(optional): string
- parameterCount(optional): integer(int32)
- parameters(optional): array parameters
- synthetic(optional): boolean
- typeParameters(optional): array typeParameters
- varArgs(optional): boolean
レスポンス
- application/json
201レスポンス
403レスポンス
例
ポータル・マネージャは、ポータルのメンバーとして現在WebCenter Portalに登録されているユーザーを追加できます。
ポータルにメンバーを追加するには、RESTリソースでPOSTリクエストを発行し、ポータルIDをパス・パラメータに指定して、次の必須パラメータをリクエスト本文に指定する必要があります。
-
userId
: ポータル・メンバーの名前。例: Karen。 -
role
: ポータル・メンバーに割り当てるロールの名前。
次の書式を使用して、POSTリクエストを発行します。
curl -i -X POST
-H 'Content-Type: application/json'
-d @create-member.json
http://hostname:port/rest/api/v1/portal/portals/{portalId}/members?utoken=utoken
説明:
-
create-member.json
は、リクエストの本文を含むJSONファイルです。 -
hostname:port
は、Oracle WebCenter Portalを実行中のホストとIPポートの名前です。例:example.com:8888
。 -
utoken
は、ポータルAPIにアクセスするためのAPIトークンです。例:utoken=utoken=abcdIC05zgjZoqCF8ShWL42AhTVvq-fc8uFshnw%2A%2A
。詳細は、「認証」を参照してください。 -
{portalId}
は、ポータルのshort id
です。ポータルのshort id
を取得するには、「ポータルの取得」を参照してください。
リクエスト本文の例
次は、リクエストの本文を含むcreate-member.json
ファイルのサンプルで、メンバーKaren
を追加して、ユーザーロールModerator
を割り当てる方法を示しています。
{ "userId" : "Karen", "isGroup" : false, "role" : "Moderator"}
HTTPステータス・コード
HTTP_STATUS = 201 Created
レスポンス本文の例
この例では、ポータルに作成された新しいメンバーKaren
の詳細を表示できます。メンバーのshortId
をメモします。
<?xml version="1.0" encoding="UTF-8"?>
<member resourceType="urn:oracle:webcenter:portal:member">
<id>22b487b4-9a95-48e2-888b-1b75b9952af9</id >
<shortId>Ch0</shortId>
<name>B5A0670E7AC117790$Moderator</name>
<creator>Admin</creator>
<created>2018-08-06T06:21:42.92Z</created>
<modifier>Admin</modifier>
<modified>2018-08-06T06:21:43.757Z</modified>
<namespace>member</namespace>
<currentVersionId>26bc4e57-a32d-d953c</currentVersionId>
<isGroup>false</isGroup>
<role>Moderator</role>
<permissionAction>manage,update,view</permissionAction>
<userGUID>B5A0670E7AC1443330790</userGUID>
<userId>Karen</userId>
<spaceId>HRPortal</spaceId>
<groupSpaceType>true</groupSpaceType>
</member>