Contents

Summary

Contains methods for authentication.

API Methods

POST https://services.ku.edu/TDWebApi/api/auth Copy URL

Logs in the current session with the specified parameters.

Parameters

Returns

The authentication result, which will include the text of the necessary "Bearer" token to be included with subsequent requests.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.ku.edu/TDWebApi/api/auth/getuser Copy URL

Gets the current user.

Returns

The current user. (TeamDynamix.Api.Users.User)

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://services.ku.edu/TDWebApi/api/auth/login Copy URL

Logs in the current session with the specified parameters.

Parameters

Returns

The authentication result, which will include the text of the necessary "Bearer" token to be included with subsequent requests.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

POST https://services.ku.edu/TDWebApi/api/auth/loginadmin Copy URL

Logs in the current session using a special key-based administrative service account.

The AdminTokenParameters.BEID and AdminTokenParameters.WebServicesKey are available in TDAdmin's organization detail page to any administrator with the "Add BE Administrators" permission.

This endpoint requires that the admin service account is set to Active.

Parameters

Returns

The authentication result, which will include the text of the necessary "Bearer" token to be included with subsequent requests.

Rate/Submission Limitations

Invocations of this method are rate-limited, with a restriction of 60 calls per IP address every 60 seconds.

GET https://services.ku.edu/TDWebApi/api/auth/loginsso Copy URL

Logs in the current session using single sign-on (SSO).

Returns

The authentication result, which will include the text of the necessary "Bearer" token to be included with subsequent requests.