Skip to main content
REST API reference

Update an external-role-mapping entry

PDFs

PATCH /security/external-role-mappings/{external_role}/{provider}

Introduced In: 9.16

Updates an external-role-mapping entry.

  • security login external-role-mapping modify

Parameters

Name Type In Required Description

external_role

string

path

True

External Identity provider role.

provider

string

path

True

Type of the external identity provider.

fields

array[string]

query

False

Specify the fields to return.

Request Body

Name Type Description

comment

string

Any comment regarding this external-role-mapping entry.

ontap_role

ontap_role

ONTAP role to map with the external identity role.

  • Introduced in: 9.16

timestamp

string

Date and time indicating when this external-role-mapping entry was created.
Example request 
{
  "comment": "string",
  "ontap_role": {
    "name": "admin"
  },
  "timestamp": "string"
}

Response

Status: 200, Ok
Name Type Description

comment

string

Any comment regarding this external-role-mapping entry.

ontap_role

ontap_role

ONTAP role to map with the external identity role.

  • Introduced in: 9.16

timestamp

string

Date and time indicating when this external-role-mapping entry was created.
Example response 
{
  "comment": "string",
  "ontap_role": {
    "name": "admin"
  },
  "timestamp": "string"
}

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

5636243

Provided ONTAP role is not configured.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

_links

ontap_role

ONTAP role to map with the external identity role.

Name Type Description

name

string

Role name

security_external_role_mapping

Name Type Description

comment

string

Any comment regarding this external-role-mapping entry.

ontap_role

ontap_role

ONTAP role to map with the external identity role.

  • Introduced in: 9.16

timestamp

string

Date and time indicating when this external-role-mapping entry was created.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

returned_error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.