Skip to main content

Import a connection

PATCH /unmigratedconnections/{connection_id}

Imports the connection into the NetApp Console.

Parameters

Name Type In Required Description

connection_id

string

path

True

ID of the Auth0 connection.

  • example: con_jxQFVfPHKSdiwoxs

Request Body

Imports the connection into the Console and creates a federation using the specified attributes in the request body provided.

Name Type Required Description

expirationNotificationPeriod

string

False

The time period when expiration notifications are generated. Defined values are:

  • "P7D" - Notifications are sent daily 7 days before expiration.

  • "P30D" - Notifications are sent weekly 30 days before expiration. Notifications are sent daily 7 days before expiration.

expirationTimestamp

string

False

The date that the credentials expire. This is only applicable when providerType=ENTRAID. When a certificate is provided for other provider types, the value is set to the certificate's expiration timestamp.

name

string

True

The name of the federation.

organizationId

string

True

Identifier for an organization.

stateDesired

string

True

The desired state of the connection.

type

string

True

Media type of the resource.

version

string

True

Version of the resource.
Example request 
{
  "expirationNotificationPeriod": "P30D",
  "expirationTimestamp": "2024-11-18T20:58:16.305662Z",
  "name": "Imported Federation",
  "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de",
  "stateDesired": "IMPORTED",
  "type": "application/vnd.netapp.bxp.unmigratedconnection",
  "version": "1.0"
}

Response

Status: 200, Returns the imported federation reference.
Name Type Required Description

federationId

string

False

Identifier of the federation that was created.

id

string

False

The ID of the connection in Auth0.

organizationId

string

False

Identifier for an organization.

state

string

False

The current state of the connection.

type

string

False

Media type of the resource.

version

string

False

Version of the resource.
Example response 
{
  "federationId": "645eae30-ea32-4542-af58-1d9012fed81a",
  "id": "con_jxQFVfPHKSdiwoxs",
  "organizationId": "9b0ee210-70a0-4158-b025-0decde66e4de",
  "state": "IMPORTED",
  "type": "application/vnd.netapp.bxp.unmigratedconnection",
  "version": "1.0"
}

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"
}

Definitions

See Definitions

invalidParams

Name Type Required Description

name

string

True

Name of the invalid parameter.

reason

string

True

Reason why the parameter is invalid.