Add external authentication link

This function adds an External Authentication authorization link to an account.

SecurityBasicAuth

Request

query Parameters

preferred_username required	string The preferred username of the account on the identity provider. Example: preferred_username=Example
provider_id required	string The name of the identity provider. Example: provider_id=google
subject_unique_identifier required	string The unique identifier for the user at the identity provider. Example: subject_unique_identifier=123456789012345678901
username required	string <username> The username. Example: username=example

Responses

200

HTTP Request was successful.

Response Schema: application/json

apiversion	integer The version of the API.
func	string The name of the method called.
module	string The name of the module called.
	object

get/ExternalAuthentication/add_authn_link

Request samples

CLI
URL
LiveAPI Perl
LiveAPI PHP

uapi --output=jsonpretty \
  --user=username \
  ExternalAuthentication \
  add_authn_link \
  username='example' \
  provider_id='google' \
  subject_unique_identifier='123456789012345678901' \
  preferred_username='Example'

Response samples

application/json

{"apiversion": 3,
"func": "add_authn_link",
"module": "ExternalAuthentication",
"result": {"data": null,
"errors": null,
"messages": null,
"metadata": { },
"status": 1,
"warnings": null
}
}