SlashID Identity Management API
The Identity Management API from SlashID — 72 operation(s) for identity management.
SlashID Identity Management API is one of 7 APIs that SlashID publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Identity Management. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 129 operations across 69 paths, and defines 189 schemas. It is described by OpenAPI 3.2.0, at version 1.1.
Requests are made against 2 base URLs: https://api.slashid.com, https://api.sandbox.slashid.com.
129 operations
69 paths
189 schemas
19 DELETE49 GET13 PATCH32 POST16 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 3
SlashID Identity Management API declares
3 security schemes
for authenticating requests.
An API key is passed in the header as SlashID-API-Key (ApiKeyAuth).
It accepts HTTP basic authentication (OAuth2ClientIdSecret).
It accepts HTTP bearer tokens (opaque) (OAuth2AccessTokenBearer).
By default, every request must be authenticated.
ApiKeyAuth— Authorizes the request with the organization's API Key.OAuth2ClientIdSecret— Authorizes the request with a client ID/client secret pairOAuth2AccessTokenBearer— Authorizes the request with an Access Token for the current user.
Paths & Operations 129
Across 69 paths, the API surfaces 129 operations — 19 DELETE, 49 GET, 13 PATCH, 32 POST, 16 PUT. Each is listed below with its method, path, parameters, and response codes.
Identity Management 129
POST
/token/validate
Validate a user token
POST
/sso/oidc/tokens/revokedeprecated
(Deprecated) Revoke an OAuth token obtained through SSO with OIDC
POST
/sso/oidc/tokens/revoke/v2
Revoke an OAuth token obtained through SSO with OIDC
GET
/sso/oidc/tokens
Retrieve OIDC tokens
POST
/sso/oidc/tokens/query
Query tokens obtained through SSO with OIDC
POST
/persons/{person_id}/direct-id
Get Direct-ID value for a person
POST
/persons/{person_id}/mint-token
Mint a token for a person
GET
/persons/{person_id}/credentials
Retrieve a person's credentials
POST
/persons/{person_id}/credentials
Create a new credential
DELETE
/persons/{person_id}/credentials
Delete all credentials
DELETE
/persons/{person_id}/credentials/{credential_id}
Delete a credential object
PUT
/persons/{person_id}/credentials/password
Create or overwrite a password credential.
POST
/persons/{person_id}/credentials/password-reset
Trigger a password reset flow
POST
/persons/{person_id}/credentials/password-rotate
Rotate a person's password
PATCH
/persons/{person_id}/attributes
Create or modify attributes for a person in multiple buckets
PUT
/persons/{person_id}/attributes
Create or modify attributes for a person in multiple buckets
GET
/persons/{person_id}/attributes
Retrieve attributes for a person from multiple buckets
PATCH
/persons/{person_id}/attributes/{bucket_name}
Create or modify attributes for a person in a single bucket
PUT
/persons/{person_id}/attributes/{bucket_name}
Create or modify attributes for a person in a single bucket
GET
/persons/{person_id}/attributes/{bucket_name}
Retrieve attributes for a person from a single bucket
DELETE
/persons/{person_id}/attributes/{bucket_name}
Delete attributes for a person from a single bucket
GET
/persons/{person_id}/consent/gdpr
Get GDPR consent
POST
/persons/{person_id}/consent/gdpr
Store GDPR consent
PUT
/persons/{person_id}/consent/gdpr
Set GDPR consent
DELETE
/persons/{person_id}/consent/gdpr
Remove GDPR consent
GET
/consent/gdpr
Get GDPR consent of current user
POST
/consent/gdpr
Store GDPR consent of current user
PUT
/consent/gdpr
Set GDPR consent of current user
DELETE
/consent/gdpr
Remove GDPR consent of current user
GET
/persons/{person_id}
Retrieve a person
DELETE
/persons/{person_id}
Delete a person from an organization
PATCH
/persons/{person_id}
Modify an existing person
POST
/persons/{person_id}/handles
Add handles to a person
GET
/persons/{person_id}/handles
Get handles for a person
DELETE
/persons/{person_id}/handles/{handle}
Delete a handle from a person
GET
/persons/{person_id}/groups
Get groups for a person
PUT
/persons/{person_id}/groups
Set the groups for a person
GET
/persons/{person_id}/permissions
Get permissions for a person
GET
/persons/{person_id}/additional-permissions
Get additional permissions for a person
PUT
/persons/{person_id}/additional-permissions
Set the permissions for a person
GET
/persons/{person_id}/roles
Get roles for a person
PUT
/persons/{person_id}/roles
Set the roles for a person
GET
/persons/{person_id}/organizations
Retrieve the list of person's organizations
POST
/persons
Create new person
PUT
/persons
Create or update a person (idempotent)
GET
/persons
Retrieve a list of persons
GET
/persons/bulk-import
Fetch the import CSV template
POST
/persons/bulk-import
Bulk import persons
POST
/groups
Create a group
GET
/groups
Get a list of groups
GET
/groups/{group_name}
Get a group
DELETE
/groups/{group_name}
Delete a group
POST
/groups/{group_name}/persons
Add persons to a group
GET
/groups/{group_name}/persons
List the persons in a group
DELETE
/groups/{group_name}/persons/{person_id}
Delete a person from a group
POST
/rbac/permissions
Create a permission
GET
/rbac/permissions
Get a list of permissions
GET
/rbac/permissions/{permission_name}
Get a permission
PATCH
/rbac/permissions/{permission_name}
Update a permission
DELETE
/rbac/permissions/{permission_name}
Delete a permission
POST
/rbac/roles
Create a role
GET
/rbac/roles
Get a list of roles
GET
/rbac/roles/{role_name}
Get a role
PATCH
/rbac/roles/{role_name}
Update a role
DELETE
/rbac/roles/{role_name}
Delete a role
POST
/rbac/check
Check whether a person has a permission
GET
/organizations/config/external-credentials
List available external credentials
POST
/organizations/config/external-credentials
Create a new set of external credentials
DELETE
/organizations/config/external-credentials
Remove an external credential by id
GET
/organizations/config/external-credentials/{cred_id}
Get the specified credential
PATCH
/organizations/config/external-credentials/{cred_id}
Modify the selected credential
GET
/organizations/config/templates
List available templates
GET
/organizations/config/templates/{template_name}
Get the named template
PUT
/organizations/config/templates/{template_name}
Modify the named template
GET
/organizations/config/domains
List the allowed domains
DELETE
/organizations/config/domains
Remove allowed domains
POST
/organizations/config/domains
Add allowed domains
GET
/organizations/config/token-template
Get the organization's token template
PUT
/organizations/config/token-template
Modify the organization's token template
GET
/organizations/sso/oidc/provider-credentials
List OIDC credentials for SSO
POST
/organizations/sso/oidc/provider-credentials
Create a new set of OIDC provider credentials for SSO
GET
/organizations/sso/oidc/provider-credentials/{oauth_client_id}
Get an existing set of OIDC provider credentials for SSO
DELETE
/organizations/sso/oidc/provider-credentials/{oauth_client_id}
Delete an existing set of OIDC provider credentials for SSO
PATCH
/organizations/sso/oidc/provider-credentials/{oauth_client_id}
Modify an existing set of OIDC provider credentials for SSO
GET
/organizations
Retrieve information about an organization
DELETE
/organizations
Delete an organization
PATCH
/organizations/attributes
Create or modify attributes for the organization in multiple buckets
PUT
/organizations/attributes
Create or modify attributes for the organization in multiple buckets
GET
/organizations/attributes
Retrieve attributes for the organization from multiple buckets
PATCH
/organizations/attributes/{bucket_name}
Create or modify attributes for the organization in a single bucket
PUT
/organizations/attributes/{bucket_name}
Create or modify attributes for the organization in a single bucket
GET
/organizations/attributes/{bucket_name}
Retrieve attributes for the organization from a single bucket
DELETE
/organizations/attributes/{bucket_name}
Delete attributes for the organization from a single bucket
GET
/organizations/suborganizations
List suborganizations
POST
/organizations/suborganizations
Create a suborganization
PUT
/organizations/api-keys
Generate a new API key for the specified organization
GET
/organizations/config
Get organization config
PATCH
/organizations/config
Update organization config
GET
/organizations/quota/current-tier
Get current pricing tier details.
GET
/organizations/quota/all-tiers
Get details on all pricing tiers.
GET
/organizations/quota/usage
Get resource usage for the organization hierarchy.
GET
/organizations/attribute-buckets
List organization's attribute buckets
GET
/organizations/config/kyc
Get organization KYC config
PATCH
/organizations/config/kyc
Update KYC organization config
POST
/organizations/webhooks
Create a new webhook
GET
/organizations/webhooks
List all webhooks
GET
/organizations/webhooks/{webhook_id}
Get a webhook
PATCH
/organizations/webhooks/{webhook_id}
Update a webhook
DELETE
/organizations/webhooks/{webhook_id}
Delete a webhook
GET
/organizations/webhooks/{webhook_id}/triggers
List webhook triggers
POST
/organizations/webhooks/{webhook_id}/triggers
Create a webhook trigger
DELETE
/organizations/webhooks/{webhook_id}/triggers
Delete a webhook trigger
GET
/organizations/webhooks/verification-jwks
Retrieve verification JWKS for webhooks
POST
/oauth2/clients
Create a new OAuth2 client
GET
/oauth2/clients
Retrieve a list of OAuth2 clients
GET
/oauth2/clients/{oauth_client_id}
Retrieve an OAuth2 client
DELETE
/oauth2/clients/{oauth_client_id}
Delete an existing OAuth2 client
PATCH
/oauth2/clients/{oauth_client_id}
Modify an existing OAuth2 client
PUT
/oauth2/clients/{oauth_client_id}/secret
Generate a new client secret
GET
/oauth2/clients/{oauth_client_id}/ui-configuration
Retrieve the configuration for the hosted UI
PUT
/oauth2/clients/{oauth_client_id}/ui-configuration
Modify the configuration for the hosted UI
GET
/oauth2/authorize
Request an authorization code
POST
/oauth2/tokens
Obtain an access token
POST
/oauth2/tokens/revoke
Revoke a token
POST
/oauth2/tokens/revoke-all
Revoke tokens
POST
/oauth2/tokens/introspect
Introspect an access token
POST
/oauth2/tokens/mint
Mint OAuth 2.0 & OIDC tokens
GET
/oauth2/userinfo
Retrieve a person's profile
POST
/oauth2/userinfo
Retrieve a person's profile
Schemas 189
The contract defines 189 schemas that model the data the API accepts and returns. The most detailed are OAuthClientUIConfiguration (13 properties), OrganizationConfig (13 properties), OAuth2Client (11 properties), OrganizationConfigPatchRequest (10 properties). Each schema is shown below with its type and property counts.
PricingTierConstraints
object
Details of the constraints applied to a specific pricing tier.
6 properties
3 required
PostOAuth2TokenRequest
PostOAuth2TokenRequestAuthorizationCode
object
6 properties
4 required
OAuthGoogleProviderOptions
object
1 property
ListGroupsResponse
array
OAuthCredentialGetResponse
object
Response when retrieving an OAuth credential
6 properties
2 required
OAuthGitlabProviderOptions
object
1 property
PasswordCredential
object
3 properties
2 required
ExternalProvider
string
Credential
object
TriggerType
string
OAuthFacebookProviderOptions
object
1 property
OAuth2ScopesSpaceDelimited
string
List of OAuth2 scopes, delimited with spaces.
PostRBACCheckResp
object
1 property
1 required
OAuth2ClientResponseTypes
array
The client's allowed response types. All allowed combinations of response types have to be listed.
OAuthClientUIConfiguration
object
13 properties
WebhookPostRequest
PostMintTokenRequest
object
1 property
PersonPatchReq
object
Structure to modify a person
1 property
PostRoleRequest
object
3 properties
1 required
OAuthClientID
string
OAuth2ClientSecretResponse
object
1 property
1 required
SsoOidcTokensQueryReq
object
3 properties
1 required
RoleName
string
The Role name must be unique within your organization; is case-sensitive; and must conform to the following: - must be at least 2 characters long - may be at m…
Organization
object
4 properties
3 required
GDPRConsent
object
2 properties
2 required
ExternalCredID
string
External credential ID
PatchBucketedAttributesReq
OAuth2AuthTokenType
string
PutPersonRolesRequest
object
1 property
1 required
OrganizationConfig
object
Configuration values for an organization. Note that some values are read-only.
13 properties
10 required
PersonHandle
object
2 properties
2 required
PersonsBulkImportResponse
object
3 properties
2 required
ExportedPasswordCredential
object
AttributeSharingScope
string
The scope in which attributes in this bucket are available
OrganizationDomainPattern
string
ExternalCredentialContent
object
Free form object for implicit server to server authentication credentials, different schema for provider.
OAuth2ClientName
string
Human-friendly name to identify this client.
PersonsPutResponse
PostOAuth2ClientRequest
object
7 properties
3 required
OAuth2TokenType
string
OAuthCredentialPatchRequest
object
Request to modify an existing OAuth credential
6 properties
GDPRConsentRequest
object
1 property
1 required
PutPersonPermissionsRequest
object
1 property
1 required
OAuth2ClientPublic
boolean
Indicates if this client is marked as public. Public clients are unable to use registered client secrets, such as applications running in a browser or on a mob…
AuthnRedirectPageUIConfig
object
UI configuration for the hosted page users are redirected to after clicking a magic link or password reset link.
WebhookPatchRequest
object
5 properties
OrganizationConfigPatchRequest
object
Request for updating organization configuration values.
10 properties
PostOAuth2TokenRequestClientCredentials
object
2 properties
1 required
RevokeAllOAuth2TokensRequest
object
2 properties
1 required
APICursorPagination
object
3 properties
3 required
PutPersonGroupsReq
object
1 property
PublicKeyCredentialParams
object
4 properties
4 required
OAuth2ClientWithSecret
GDPRConsentLevel
string
OAuth2ClientSecret
string
The client secret key.
TemplateName
string
Identifier for an e-mail/SMS message template The following templates are available for customization: - emailauthnchallenge: E-mail template with magic link;…
OAuthClientUIConfigurationPutResponse
GetPersonOrganizationsResponse
array
GetAttributesResp
PostGroupPersonsReq
object
1 property
1 required
OAuthAzureADProviderOptions
object
2 properties
TokenText
string
A JWT token. Can be either a User token (UserTokenText) or a Token Container (TokenContainerText)
PasswordRotatePostResp
object
1 property
BucketedAttributes
object
Attributes divided into named buckets. Bucket names are top level keys; attributes are values. Attributes consist of key-value pairs. Attribute names (keys) ma…
SsoOidcTokensGetResponse
array
SsoOidcTokensRevokeV2Req
object
3 properties
2 required
WebhookPatchResponse
PatchExternalCredentialRequest
object
2 properties
PersonsBulkImportRequest
object
1 property
1 required
PersonType
string
EventTrigger
object
2 properties
2 required
OrganizationKYCConfigPatchRequest
Bytes
string
OAuthGithubProviderOptions
object
1 property
SuborganizationCreateRequest
object
5 properties
2 required
APIMeta
object
2 properties
ExternalCredentialPostRequest
object
Request to create a new external credential
4 properties
3 required
GDPRConsentResponse
object
1 property
1 required
OrganizationsPutAPIKeyResponse
object
1 property
1 required
ExportedCredential
SsoOidcTokensQueryResp
array
JWKS
object
PersonPermissionsResponse
array
ExportedTOTPCredential
object
PersonFieldName
string
AttributePermissions
string
The access level for end-users to attributes in this bucket.
PersonsPostResponse
WebhookTriggerPostRequest
PostOAuth2TokenResponseClientCredentials
object
4 properties
3 required
GroupName
string
WebhookTrigger
IntrospectOAuth2TokenRequest
object
3 properties
1 required
OrganizationCreateResponse
OAuth2ClientRefreshTokenDuration
integer
How long (in seconds) refresh tokens should be valid for. If unspecified, this defaults to 10 days (864,000 seconds).
PersonCreateReq
PersonID
string
Person ID
TOTPCredentialParams
object
3 properties
3 required
OIDCTokenType
string
PostOAuth2TokenResponseRefreshToken
object
6 properties
3 required
SsoOidcTokenDetail
object
9 properties
8 required
OAuth2ClientRedirectURIs
array
The client's allowed redirect URIs.
OAuthAppleProviderOptions
object
See https://developer.apple.com/documentation/accountorganizationaldatasharing/creating-a-client-secret
5 properties
4 required
WebhookConfiguration
object
5 properties
2 required
PutBucketedAttributesReq
GetGroupResponse
object
4 properties
3 required
PersonHandleType
string
TOTPCredential
object
3 properties
2 required
APIPagination
object
3 properties
3 required
ListPermissionsResponse
array
OrganizationResponse
MintOAuth2TokensRequest
object
4 properties
2 required
OAuthProvidersOptions
object
Options for supported third-party providers.
9 properties
FactorMethod
string
Allowed login factor
APIResponseBase
object
2 properties
PasswordResetPostReq
object
2 properties
RevokeOAuth2TokenRequest
object
2 properties
1 required
Attributes
object
Clear-text person attributes as key-value pairs. Attribute names (keys) may be at most 70 bytes long. Attribute values must be JSON-serializable and are limite…
ExternalCredential
object
6 properties
5 required
UserinfoOAuth2Response
object
9 properties
4 required
OrganizationKYCConfig
object
Configuration values related to KYC for an organization.
1 property
GetBucketedAttributesResp
PostGroupReq
object
2 properties
1 required
Webhook
object
OAuth2ClientScopes
array
The scopes this client is allowed to request.
ListRolesResponse
array
ExternalCredTypes
string
OAuthBitbucketProviderOptions
object
1 property
OrganizationUsageDetails
object
Details of how many suborganization/persons/groups have been used by this organization hierarchy.
4 properties
3 required
MessageTemplate
object
Template for E-mail or SMS messages. Empty fields fall back to default value.
3 properties
OAuth2Scope
string
OAuth2 scope
PersonHandlesResponse
array
WebhookPostResponse
PostOAuth2TokenResponseAuthorizationCode
object
6 properties
3 required
OAuth2GrantType
string
PersonDirectIDReq
object
1 property
1 required
OAuthProvider
string
OAuthTokenRevokeReq
object
3 properties
3 required
OAuth2Client
object
11 properties
6 required
OrganizationDetails
ExportedCredentialBase
object
2 properties
1 required
Region
string
OAuth2ClientGrantTypes
array
The client's allowed grant types.
PostOAuth2TokenResponse
GlobPattern
string
A glob pattern
TokenTemplate
object
Template for user tokens emitted on authentication.
1 property
1 required
OAuthLineProviderOptions
object
1 property
PublicKeyCredential
object
3 properties
2 required
OrganizationDomainsPatchRequest
object
1 property
PatchAttributesReq
OrganizationID
string
OAuthCredentialPostRequest
object
Request to create a new OAuth credential
8 properties
3 required
ValidateTokenResponse
object
4 properties
1 required
OAuthOktaProviderOptions
object
2 properties
PostPermissionRequest
object
2 properties
1 required
SyncHookName
string
MintOAuth2TokensResponse
object
3 properties
1 required
PersonGroupsResponse
array
PublicKeyAuthenticator
object
3 properties
1 required
PermissionName
string
The permission name must be unique within your organization; is case-sensitive; and must conform to the following: - must be at least 2 characters long - may b…
CredentialType
string
The type of the credential
UserTokenText
string
PasswordCredentialParams
object
1 property
1 required
APIResponseError
object
2 properties
PersonRolesResponse
array
GetRoleResponse
object
4 properties
3 required
PricingTier
string
The tier associated with a root organization. Your organization may be subject to various constraints depending on its tier, such as maximum number of users, r…
DirectID
PutAttributesReq
PostRBACCheckRequest
object
2 properties
2 required
PostOAuth2TokenRequestRefreshToken
object
3 properties
2 required
OAuth2ClientID
string
The client identifier.
GetPermissionResponse
object
3 properties
2 required
PersonHandlesReq
array
ValidateTokenReq
object
1 property
1 required
EventName
string
IntrospectOAuth2TokenResponse
object
5 properties
1 required
OAuthClientUIConfigurationPutRequest
AttributeBucket
object
An attribute bucket with access settings
4 properties
3 required
PatchOAuth2ClientRequest
object
6 properties
SyncHookTrigger
object
2 properties
2 required
PersonRet
object
Abridged person structure
7 properties
4 required
OAuth2ResponseType
string
PatchRoleRequest
object
2 properties
PatchPermissionRequest
object
1 property
OAuth2ClientAccessTokenDuration
integer
How long (in seconds) access tokens should be valid for. If unspecified, this defaults to 24 hours (86,400 seconds). For OIDC flows, this value is also used as…
OAuthClientUIConfigurationGetResponse
ExportedPublicKeyCredential
object
ExportedTOTPCredentialParams
object
2 properties
2 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from SlashID 6
Other APIs SlashID publishes across the network.
SlashID OIDC discovery API
SlashID Organization SSO config API
SlashID Organization Webhooks API
SlashID Super Admin Management API
SlashID Tokens API
SlashID Workflows API
#Identity Management
Where this information came from
This is an independent, third-party profile of SlashID Identity Management API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.