Login to NexPortNexPort Solutions

SsoApi

Automatically log users into Nexport with out requiring their login credentials. Can also create a redirect entity to attach to the subscription of the user in the organization which will cause them to be redirected upon logging out, using an expired token, or using an invalid token (if those urls are set). Can use either user_id and org_id OR just subscription_id. Requires the Use SSO API permission in the subscription organization or an ancestor.

post
Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

A request for an SSO token. Use user_id and org_id OR just use subscription_id for specifying the subscription.

displayinteger · enumOptional

Dictates whether to use the normal student display or an alternate "no chrome" display which removes the NexPort header and menu items from the top of the page. Normal=0; NoChrome=1;0 = Normal, 1 = NoChrome

Possible values:
user_idstring · uuidOptional

Id of the user being signed in

Example: 00000000-0000-0000-0000-000000000000
org_idstring · uuidOptional

Id of the organization the user has a subscription in

Example: 00000000-0000-0000-0000-000000000000
subscription_idstring · uuidOptional

Id of the subscription. Use this if user_id and org_id are not supplied.

Example: 00000000-0000-0000-0000-000000000000
Responses
200

Sign on url and authentication token information

post
POST /api/v1/SsoApi/SignIn HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 269

{
  "display": 0,
  "user_id": "00000000-0000-0000-0000-000000000000",
  "org_id": "00000000-0000-0000-0000-000000000000",
  "subscription_id": "00000000-0000-0000-0000-000000000000",
  "redirect_entity_request": {
    "logout_url": "text",
    "invalid_token_url": "text",
    "expired_token_url": "text"
  }
}
{
  "url": "text",
  "access_token": "00000000-0000-0000-0000-000000000000",
  "token_type": "text",
  "expires_in": 1,
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}

Retrieves url of classroom student view for a particular enrollment. Can also create a redirect entity to attach to the subscription of the enrollment which will cause the subscribed user to be redirected upon logging out, using an expired token, or using an invalid token (if those urls are set). Requires the Use SSO API permission in the enrollment subscription organization or an ancestor.

post
Query parameters
access_tokenstringRequired

Use the AdminApi Authenticate method to get the access_token

Body

Class for retrieving the url of the classroom student view

displayinteger · enumOptional

Dictates whether to use the normal student display or an alternate "no chrome" display which removes the NexPort header and menu items from the top of the page. Normal=0; NoChrome=1;0 = Normal, 1 = NoChrome

Possible values:
enrollment_idstring · uuidRequired

Id of the enrollment

Example: 00000000-0000-0000-0000-000000000000
Responses
200

Classroom url and authentication token information

post
POST /api/v1/SsoApi/Classroom HTTP/1.1
Host: www.nexportcampus.com
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "display": 0,
  "enrollment_id": "00000000-0000-0000-0000-000000000000",
  "redirect_entity_request": {
    "logout_url": "text",
    "invalid_token_url": "text",
    "expired_token_url": "text"
  }
}
{
  "url": "text",
  "access_token": "00000000-0000-0000-0000-000000000000",
  "token_type": "text",
  "expires_in": 1,
  "api_error_entity": {
    "error_code": 0,
    "error_message": "text",
    "warning_messages": [
      "text"
    ]
  }
}
PreviousScormApiNextModels