PUT /api/groups/{GroupID}/members/{UserID}/role

Changes the role assigned to the specified member in the specified group.

Authorization Roles/Permissions: Must be logged in. Must have Modify permission for the resource. For example, a group leader can perform this action.

This topic includes the following sections:

HTTP Method

PUT

Back to top

URL

https://{hostname}/api/groups/{GroupID}/members/{UserID}/role

Back to top

Sample Request

The example below shows a request to change the role of the specified member to a leader role.

Request URL

https://{hostname}/api/groups/group19212.acmepaymentscorp/members/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/role

Sample request headers

PUT /api/groups/group19212.acmepaymentscorp/members/d4e9b5d9-bd93-4c4e-acfd-bcf23527c729.acmepaymentscorp/role HTTP/1.1
Host: {hostname}
Accept: text/plain, */*; q=0.01
Content-Type: application/json; charset=UTF-8
X-Csrf-Token_acmepaymentscorp":"TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

com.soa.group.membership.role.leader

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept Any Accept header value that supports a response Content-Type of text/plain is valid; for example, */*.
Content-Type

Any one of the following media types is valid for the request Content-Type:

application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json

X-Csrf-Token_{fedmemberID} The CSRF prevention header; may or may not be required, depending on platform settings. See CSRF Prevention on the Platform. By default, the CSRF header is not required for GET operations and is required for all others, with a few exceptions relating to user login.

Back to top

Request Parameters

Parameter Parm Type Data Type Required Description
GroupID Path string Required The unique ID for a specific group.
UserID Path string Required The unique ID for a specific user.
Role Body string Required The new value for the user's role; for example, com.soa.group.membership.role.leader. For a list of values, see Group Member Roles.

Back to top

Response

If successful, this operation returns HTTP status code 200. There is no response content.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers

HTTP/1.1 200 OK
Date: Fri, 14 Jun 2013 15:47:56 GMT
Content-Length: 0

Sample response body

None.

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type text/plain

Back to top

Response Body

None.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
405 Method Not Allowed. For example, you might get this if you specified an invalid Accept header or omitted a required Content-Type header, or used the wrong HTTP verb.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics