Skip to main content

Getting Started

Overview

With the System for Cross-domain Identity Management (SCIM) API, you can perform Access Management activities within the StackSpot Portal using HTTP methods (GET, POST, PUT, PATCH, DELETE).

Requirements

  • Due to authentication restrictions, direct API submission is only available for Enterprise accounts.

  • Authenticate to use the script.

Follow the steps to authenticate on the Service Credentials page.

Activate the following permissions: scim_use

Contact your account administrator if you are unable to create a Service Credential.


  • Copy the 'client id', 'client key', and 'realm' fields to use as environment variables (the first two must be secrets) or in the curl example at the bottom of the page in the 'how to use' section. You will not be able to view them again.
danger

If you lose any of them, revoke the credential and create a new one.

  • The following examples assume the access token is set as the JWT environment variable. You can extract this from the curl authentication with the jq command to get the value for the access_token key from the returned JSON, then save it as an environment variable using the export command, like this:
export JWT=$(curl -s "https://idm.stackspot.com/$REALM/oidc/oauth/token" -H 'Content-Type: application/x-www-form-urlencoded' -d 'grant_type=client_credentials' -d "client_id=$CLIENT_ID" -d "client_secret=$CLIENT_KEY" | jq -r '.access_token')

Next Step