OKTA SINGLE SIGN ON
API Documentation

This is a self-navigating API documentation. Please feel free to explore across the Index. API calls gives you a hands-on experience of those methods provided. Field reference lists, describes the type of information provided by the API.

OKTA SSO API

https://www.okta.com/products/single-sign-on/

Method

'passport-saml'

Request

callbackUrl: 'https://api.auctionsoftware.com/sso',

entryPoint: 'https://auc18.okta.com/app/auc1/exkebj9bCwly4inex355/sso/saml',

issuer: 'http://www.okta.com/exkebj9bCwly4inex355',

cert: fs.readFileSync('./okta.cert', 'utf-8'), // <-- cert file from okta

Responses
Status: 200 - Success
  • {
    • $ status : success; $ result['auth'] = ‘authtoken’; $ result['user_id'] = user_id; $ result['user_name'] = 'username'; $ result['email_id'] = ‘user_email’;
    }
Responses
Status: 403 - Error
  • {
    • $ status : false; $ error: ‘error message’;
    }