Versions Compared

Version Old Version 1 New Version Current
Changes made by

Abhineet Mittal

Abhineet Mittal

Saved on

Key

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

Overview

The USTA API uses Okta as an identity provider organized using the OAuth2 access model. Web and mobile applications interact with Okta using https.

Grant Types - Okta

Applications can use one of two OAuth2 grant types:

  • Authorization Code used for browser applications where the user authenticates as themselves.

  • Client Credentials used for server-side applications where the service authenticates as the service and establishes a session.

Credentials

After discussion with the USTA API team, USTA will issue credentials for the appropriate grant type to the application developers.

API Endpoints

Stage Domain Name:

 

Okta (Target)

Cognito (Legacy)

Authorize endpoint

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • client_id={client_id}

  • response_type=code

  • scope=openid offline_access

  • redirect_uri={client_redirect_uri}

  • audience= {AUDIENCE}

  • organization={organization_id}

  • state={state}

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • redirect_uri={client_redirect_uri}

  • state={state}

Token endpoint

(Authorization code flow)

Method: POST

URL: /wiki/spaces/UDTP/pages/40676753780

Headers:

  • Authorization='Basic {client_id&client_secret}'

Body:

  • client_id={client_id}

  • grant_type=refresh_token

  • refresh_token={refresh_token}

Method: POST

URL: /wiki/spaces/UDTP/pages/40676753780

Headers:

  • Authorization='Basic {client_id&client_secret}'

Body:

  • client_id={client_id}

  • grant_type=refresh_token

  • refresh_token={refresh_token}

Token endpoint

(Client credentials flow)

Method: POST

URL: /wiki/spaces/UDTP/pages/40550268943

Body:

  • grant_type=client_credentials

  • client_id={client_id}

  • client_secret={client_secret}

  • audience= {AUDIENCE}

Content-type: x-www-form-urlencoded

Method: POST

URL: /wiki/spaces/UDTP/pages/40676753780

Headers:

  • Authorization='Basic {client_id&client_secret}'

Body:

  • client_id={client_id}

  • grant_type=client_credentials

Refresh token endpoint

Method: POST

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • client_id={client_id}

  • grant_type=refresh_token

  • refresh_token={refresh_token}

Method: POST

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • client_id={client_id}

  • grant_type=refresh_token

  • refresh_token={refresh_token}

Logout endpoint

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • client_id={client_id}

  • returnTo={logout_uri}

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • logout_uri={logout_uri}

  • state={state}

Userinfo endpoint

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Headers:

  • Authorization='Bearer {ACCESS_TOKEN}'

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Headers:

  • Authorization='Bearer {ACCESS_TOKEN}'

Forgot password endpoint

Not directly supported by OKTA. Flow needs to be changed https://community.auth0.com/t/feature-request-allow-a-direct-link-to-forgot-password/60754

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • redirect_uri={client_redirect_uri}

  • state={state}

 

Signup endpoint

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • client_id={client_id}

  • response_type=code

  • scope=openid offline_access

  • redirect_uri={client_redirect_uri}

  • audience= {AUDIENCE}

  • organization={organization_id}

  • state={state}

  • screen_hint=signup

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • redirect_uri={client_redirect_uri}

  • state={state}

Login endpoint

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • client_id={client_id}

  • response_type=code

  • scope=openid offline_access

  • redirect_uri={client_redirect_uri}

  • audience= {AUDIENCE}

  • organization={organization_id}

  • state={state}

Method: GET

URL: /wiki/spaces/UDTP/pages/40676753780

Parameters:

  • redirect_uri={client_redirect_uri}

  • state={state}

Get Customer endpoint

https://services.usta.com/v1/customers/me

 

Post Customer endpoint

https://services.usta.com/v1/customers

 

Panel
bgColor#FFFFFF

On This Page:

Panel
bgColor#FFFFFF

Subtopics:

 

Panel
bgColor#FFFFFF

On This Page:

Table of Contents
Panel
bgColor#FFFFFF

Subtopics:

Child pages (Children Display)