Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You will also need to support TLS v1.2 or above as connections using the older protocols will be rejected. 

...

PropertyRequiredDescription
connectionIDyesUnique identifier for the local authentication system connection.
uniqueUserIdentifieryes

A unique identifier for the end-user account in the local authentication system. This must be unique to each end-user, persistent between logins, and  should ideally be pseudonymous and unique to the user for all time.

displayNameyesA human-readable display name for the account holder. Appears in account lists and the audit trail.
returnUrlyesA URL in your application that the user will be returned to after the OpenAthens session initiator URL is visited.
attributesonly when marked as required in attribute mappings in UIA set of additional attributes for the account holder that can be mapped via the UI. This may contain permission sets if mapped via the UIis also where you would put permission set identifiers if mapping that way.

The response to the session initiator request will be a application/vnd.eduserv.iam.auth.accountSessionInitiator+json object:

...