Update Auto Role Settings (For partner user only)

Overview

Update auto role setting for partner user. This API can use Partner user only. Users with on setting automatically have assignment to the tenant when viewing the tenant information of the child contract.

Classification

  • Update

API Operation Object

  • user

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{api_endpoint}/api/v2/users/{user_id}/auto-role-assignment

Request Parameter

Request Parameters
item mandatory format description
user_id o String The User who wants to set automatic role to child contract tenant

HTTP Request Header

X-Auth-Token: <token_id>
Content-Type: application/json

HTTP Request Body

{
     "auto_role_assignment_flag" : true
 }

Request Parameter

Request Parameters
item mandatory format description
auto_role_assignment_flag o Boolean You set whether on or not(true: on setting, false: off setting)

Response

Response Header

Format

HTTP/1.1 <response_code> <response_code>       (ex. 200 200)
  • <response_code>: see “HTTP Responses” section
  • <message>: message based on the response code

(skip auto insert field such as “Connection” and “Content-Length”, “Set-Cookie”, etc.)

Response Code

Response Codes
response code condition
204 No Content
400 Request format is invalid
401 Unauthorized
403 Not permitted for this user
404 Not found a specified resource
409 designated login conflicts existing user

Response Body

Format

No response

Response Parameter

No response body

Sample Request and Response

Sample API Request

curl -1 -i -X PUT -H"Content-Type: application/json" -H"X-Auth-Token: dec164faee114049ab3d33edcb7aea0e" -d '{
  "auto_role_assignment_flag" : true
}' https://sss-jp1-ecl.api.ntt.com/api/v2/users/ecid1000014777/auto-role-assignment

Sample API Response

HTTP/1.1 204 204
Date: Tue, 05 Feb 2019 01:45:02 GMT
Content-Length: 0
Connection: keep-alive
ECL-Transaction-ID: b7a3d752-5c2e-406f-9841-7a71ad37e195
Set-Cookie: TS0183560f=01cce65ce10f9038eaa421550fffae50fc16fca71ba3341ad51a43159be17d3945558c1615; Path=/

Sample Error Message

HTTP/1.1 404 404
Date: Tue, 05 Feb 2019 01:46:23 GMT
Content-Type: application/json
Content-Length: 65
Connection: keep-alive
Set-Cookie: TS0183560f=01059ca7b1ed53ac249469b039129391e114cfb554d76696527ba0f77fd9cad3941fdf6d78; Path=/
{"code":404,"title":"Not Found","message":"User does not exist."}