Skip to main content
REST API reference

Retrieve all external-role-mapping entries

PDFs

GET /security/external-role-mappings

Introduced In: 9.16

Retrieves all external-role-mapping entries.

  • security login external-role-mapping show

Parameters

Name Type In Required Description

timestamp

string

query

False

Filter by timestamp

external_role

string

query

False

Filter by external_role

comment

string

query

False

Filter by comment

provider

string

query

False

Filter by provider

ontap_role.name

string

query

False

Filter by ontap_role.name

fields

array[string]

query

False

Specify the fields to return.

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

  • Default value: 1

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

  • Default value: 1

  • Max value: 120

  • Min value: 0

order_by

array[string]

query

False

Order results by specified fields and optional [asc

Response

Status: 200, Ok
Name Type Description

_links

collection_links

num_records

integer

Number of records.

records

array[security_external_role_mapping]
Example response 
{
  "_links": {
    "next": {
      "href": "/api/resourcelink"
    },
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "records": [
    {
      "_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

next

href

self

href
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

security_external_role_mapping

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.

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.