Skip to main content
REST API reference

Retrieve an external-role-mapping entry

PDFs

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

Introduced In: 9.16

Retrieves an external-role-mapping entry.

  • security login external-role-mapping show

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.

Response

Status: 200, Ok
Name Type Description

_links

self_link

comment

string

Any comment regarding this external-role-mapping entry.

external_role

string

External Identity provider role.

ontap_role

ontap_role

ONTAP role to map with the external identity role.

  • Introduced in: 9.16

provider

string

Type of the external identity provider.

timestamp

string

Date and time indicating when this external-role-mapping entry was created.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "comment": "string",
  "external_role": "string",
  "ontap_role": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "admin"
  },
  "provider": "string",
  "timestamp": "string"
}

Error

Status: Default, Error
Name Type Description

error

returned_error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string
Name Type Description

self

href

_links

Name Type Description

self

href

ontap_role

ONTAP role to map with the external identity role.

Name Type Description

_links

_links

name

string

Role name

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.