Skip to main content

Associate users in an organization with a role

Contributors

POST /organizations/{organization_id}/roles/{role_id}/users

Associates users with a role under the specified organization.

Parameters

Name Type In Required Description

organization_id

string

path

True

role_id

string

path

True

Request Body

Indicates the desired values to associate multiple users with a specific role under an organization.

Name Type Required Description

type

string

True

Media type of the resource. Defined values are:

  • "application/vnd.netapp.bxp.userbulk"

users

array[users]

False

JSON array of users.

version

string

True

Version of the resource. Defined values are:

  • "1.0"
Example request 
{
  "type": "application/vnd.netapp.bxp.userbulk",
  "users": [
    {
      "aadId": "a94ac68f-ea20-47aa-add8-8d41be0d8466",
      "userId": "e837c373-2ec4-47a8-b016-ba430ebce321"
    },
    {
      "auth0Id": "auth0|5a09551d0d9ef535b823bd3f",
      "userId": "f837c373-2ec4-47a8-b016-ba430ebce321"
    }
  ],
  "version": "1.0"
}

Response

Status: 202, Indicates the users request was accepted.

Error

Status: 400, Bad request
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The supplied query parameters are invalid.",
  "status": "400",
  "title": "Invalid query parameters",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 401, Unauthorized
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The request is missing the required bearer token.",
  "status": "401",
  "title": "Missing bearer token",
  "type": "https://bluexp.netapp.io/problems/1"
}

Error

Status: 403, Forbidden
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The requested operation isn't permitted.",
  "status": "403",
  "title": "Operation not permitted",
  "type": "https://bluexp.netapp.io/problems/11"
}

Error

Status: 404, Not found
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The collection specified in the request URI wasn't found.",
  "status": "404",
  "title": "Collection not found",
  "type": "https://bluexp.netapp.io/problems/2"
}

Error

Status: 409, Conflict
Name Type Required Description

correlationId

string

False

Internal UUID representing the request or trace ID related.

detail

string

False

Details about the problem.

invalidParams

array[invalidParams]

False

List of invalid parameters.

status

string

True

HTTP error code related to the problem.

title

string

True

Title description of the problem.

type

string

True

Content-type of the object.
Example error response 
{
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409",
  "title": "JSON resource conflict",
  "type": "https://bluexp.netapp.io/problems/10"
}

Definitions

See Definitions

users

Name Type Required Description

aadId

string

False

auth0Id

string

False

emailId

string

False

userId

string

False

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.