Assign Users to an Application Role or Granular Role (v1)

REST Resource

PUT /interop/rest/security/<api_version>/users

Table 2-15 Tasks for Assign Users to Roles

Task	Request	REST Resource
Assign role	PUT	/interop/rest/security/<api_version>/users
Assign role status	GET	/interop/rest/security/<api_version>/jobs/<jobid>

Request

Supported Media Types: application/x-www-form-urlencoded

Table 2-16 Parameters

Name	Description	Type	Required	Default
api_version	Specific API version	Path	Yes	None
jobtype	ASSIGN_ROLE	Form	Yes	None
filename	The name of the ANSI or UTF-8 encoded CSV file containing the login IDs of the users whose role assignment is to be modified, such as assignRoles.csv.	Form	Yes	None
rolename	The name of a application or granular role applicable to the service. An incorrect role name will result in an error. To assign users to a application role, roleName should identify a application role applicable to the service. For a list of application roles for each business process, see Understanding Application Roles in Getting Started Guide for Administrators. To assign users to a granular role, roleName should identify a granular role listed in the Assign Roles tab of Access Control. For a description of these roles, see Granular Role Assignment Overview in Administering Access Control.	Form	Yes	None

Response

Supported Media Types: application/json

Table 2-17 Parameters

Name	Description
details	In the case of errors, details are published with the error string
status	See Migration Status Codes
links	Detailed information about the link
href	Links to API call or status API
action	The HTTP call type
rel	Possible values: self or Job Status. If the value is set to Job Status, you can use the href to get the status
data	Parameters as key value pairs passed in the request
items	Details about the resource
links	Details of the first URL to be requested to get the job details; rel is "Job Details"

Examples of Response Body

Example 1: Job is in Progress

{
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/interop/rest/security/<api_version>/users",
      "data": {
        "jobType": "ASSIGN_ROLE",
        "filename": "<filename>",
        "rolename": "<rolename>"
      },
      "action": "PUT"
    },
    {
      "rel": "Job Status",
      "href": "https://<BASE-URL>/interop/rest/security/<api_version>/jobs/<jobid>",
      "data": null,
      "action": "GET"
    }
  ],
  "details": null,
  "status": -1,
  "items": null
}

Example 2: Job Completes with Errors

{
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/interop/rest/security/<api_version>/jobs/<jobid>",
      "data": null,
      "action": "GET"
    }
  ],
  "details": " Failed to assign role for users. Input file <filename> is not found. Specify a valid file name.",
  "status": 1,
  "items": null
}

Example 3: Job Completes without Errors

{
  "links": [
    {
      "rel": "self",
      "href": "https://<BASE-URL>/interop/rest/security/<api_version>/jobs/<jobid>",
      "data": null,
      "action": "GET"
    }
  ],
  "details": "Processed - 3, Succeeded - 2, Failed - 1.",
  "status": 0,
  "items": [
    {
		"UserName":"<USERNAME>","Error_Details": "User <USERNAME> is not found. Verify that the user exists."
    }
  ] 
}

Sample cURL Command Basic Auth Application Role

curl -X PUT -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/x-www-form-urlencoded' -d 'jobtype=ASSIGN_ROLE&filename=assignRoleUsers.csv&rolename=Power User' 'https://<BASE-URL>/interop/rest/security/v1/users'

Sample cURL Command Basic Auth Granular Role

curl -X PUT -s -u '<USERNAME>:<PASSWORD>' -H 'Content-Type: application/x-www-form-urlencoded' -d 'jobtype=ASSIGN_ROLE&filename=assignRoleUsers.csv&rolename=Access Control - Manage' 'https://<BASE-URL>/interop/rest/security/v1/users'

Sample cURL Command OAuth 2.0 Application Role

curl -X PUT --header "Authorization: Bearer <OAUTH_ACCESS_TOKEN>" -H 'Content-Type: application/x-www-form-urlencoded' -d 'jobtype=ASSIGN_ROLE&filename=assignRoleUsers.csv&rolename=Power User' 'https://<BASE-URL>/interop/rest/security/v1/users'

Sample cURL Command OAuth 2.0 Granular Role

curl -X PUT --header "Authorization: Bearer <OAUTH_ACCESS_TOKEN>" -H 'Content-Type: application/x-www-form-urlencoded' -d 'jobtype=ASSIGN_ROLE&filename=assignRoleUsers.csv&rolename=Access Control - Manage' 'https://<BASE-URL>/interop/rest/security/v1/users'