When calling the API v2, you can use smart IDs to pass your SSO IDs into the API as parameters. However, what if you want to get your SSO IDs out of the API? In this case, you can use the
ssoID expand parameter on API endpoints.
Here is how it works: Anytime you see an expand parameter that involves a user, you can specify another expand parameter by appending
.ssoID to the end. For example, say you are looking at the
GET /discussions endpoint, I see there is an
insertUser expand parameter. I can also specify
insertUser.ssoID to get that user's SSO ID. The call would look like this:
This would return an API result something like this:
"name": "Some discussion title",
"ssoID": "<your site's ID here>"
What SSO ID Is Expanded?
In order to have an SSO ID expanded you must have a default SSO method selected. The IDs from the default SSO provider are used.
SSO ID Permissions
SSO IDs require permission to view. If you would like to change the level of permissions for SSO IDs you can do so in the dashboard under Roles & Permissions › Advanced Settings.