API by area

SSO and SCIM

72 endpoints. Paths are relative to https://api.sandscale.dev; values in braces are ones you fill in.

API reference · Authentication · Errors

MethodPathWhat it does
POST/api/v1/svc/sso/AcceptDomainTransferAccept domain transfer
POST/api/v1/svc/sso/ActivateConnectionRevisionActivate connection revision
POST/api/v1/svc/sso/CancelDomainTransferCancel domain transfer
POST/api/v1/svc/sso/CheckConnectionRegistrationAsks the identity provider whether it accepts the connection's client authentication (a token request with a placeholder code; nobody is signed in and no token is issued). Audited with its result; at most 10 a minute per connection.
POST/api/v1/svc/sso/ConfirmEmergencyAdminConfirm emergency admin
POST/api/v1/svc/sso/ContestDomainClaimContest domain claim
POST/api/v1/svc/sso/CreateAccountAssignmentCreate account assignment
POST/api/v1/svc/sso/CreateConnectionCreate connection
POST/api/v1/svc/sso/CreateDomainClaimCreate domain claim
POST/api/v1/svc/sso/CreateGroupMappingCreate group mapping
POST/api/v1/svc/sso/CreatePermissionSetCreate permission set
POST/api/v1/svc/sso/DeleteAccountAssignmentDelete account assignment
POST/api/v1/svc/sso/DeleteConnectionDelete connection
POST/api/v1/svc/sso/DeleteDomainClaimDelete domain claim
POST/api/v1/svc/sso/DeleteGroupMappingDelete group mapping
POST/api/v1/svc/sso/DeletePermissionSetDelete permission set
POST/api/v1/svc/sso/DescribeConnectionDescribe connection
POST/api/v1/svc/sso/DescribeDomainClaimDescribe domain claim
POST/api/v1/svc/sso/DescribeInstanceDescribe instance
POST/api/v1/svc/sso/DescribePermissionSetProvisioningStatusDescribe permission set provisioning status
POST/api/v1/svc/sso/DisableConnectionDisable connection
POST/api/v1/svc/sso/EnableConnectionIdpMfaTrustTrusts the IdP's MFA instead of Sandscale's second factor at sign-in through the connection's active revision, with the policy's stored amr and acr values. Its route's re-verification is sso.idp_mfa_trust:enable; the handler refuses a caller that is not a person's own session again, a connection without an active revision, and an active revision whose latest passing test did not assert MFA by Sandscale's reading with those values. Audited with before and after, refusals too.
POST/api/v1/svc/sso/GetConnectionSessionPolicyGet connection session policy
POST/api/v1/svc/sso/GetConnectionSetupGet connection setup
POST/api/v1/svc/sso/GetConnectionTestResultGet connection test result
POST/api/v1/svc/sso/GetDomainEnforcementGet domain enforcement
POST/api/v1/svc/sso/GetJitRulesGet jit rules
POST/api/v1/svc/sso/GetMyDomainStatusGet my domain status
POST/api/v1/svc/sso/GetServiceProviderMetadataGet service provider metadata
POST/api/v1/svc/sso/ImportIdentityProviderMetadataImport identity provider metadata
POST/api/v1/svc/sso/LinkTestIdentityLinks the identity of the caller's own passing test sign-in to the caller's login. The route is a sensitive action (sso.identity:link: one factor, people only), so the caller re-verified before it runs; every condition is checked again here under a lock of the test, and the link, its record as the caller's sign-in through the connection and the audit entry are one transaction. A refusal is audited.
POST/api/v1/svc/sso/ListAccountAssignmentsList account assignments
POST/api/v1/svc/sso/ListConnectionsList connections
POST/api/v1/svc/sso/ListDomainClaimsList domain claims
POST/api/v1/svc/sso/ListDomainTransfersList domain transfers
POST/api/v1/svc/sso/ListDomainUsersList domain users
POST/api/v1/svc/sso/ListEmergencyAdminsList emergency admins
POST/api/v1/svc/sso/ListGroupMappingsList group mappings
POST/api/v1/svc/sso/ListPermissionSetsList permission sets
POST/api/v1/svc/sso/PreviewHomeRealmDiscoveryPreview home realm discovery
POST/api/v1/svc/sso/PutConnectionSessionPolicyPut connection session policy
POST/api/v1/svc/sso/PutDomainEnforcementPut domain enforcement
POST/api/v1/svc/sso/PutDomainUserActionPut domain user action
POST/api/v1/svc/sso/PutEmergencyAdminsPut emergency admins
POST/api/v1/svc/sso/PutJitRulesPut jit rules
POST/api/v1/svc/sso/RecheckDomainClaimRecheck domain claim
POST/api/v1/svc/sso/RotateServiceProviderCertificateRotate service provider certificate
POST/api/v1/svc/sso/StartConnectionTestStart connection test
POST/api/v1/svc/sso/StartDomainTransferStart domain transfer
POST/api/v1/svc/sso/StartSessionReauthenticationStarts the caller's re-authentication at the IdP its session was issued through. It acts on the caller's own session only; a session not issued through a connection (a password, passkey or root session, or an API key) is refused: its step-up is Sandscale's own second factor.
POST/api/v1/svc/sso/UpdateConnectionUpdate connection
POST/api/v1/svc/sso/UpdatePermissionSetUpdate permission set
POST/api/v1/svc/sso/VerifyDomainClaimVerify domain claim
GET/oidc/{organization_id}/callbackCallback of an oidc
GET/oidc/{organization_id}/loginAnd oidcCallback serve the legacy URLs of the organization's OIDC connection: Identity Center builds the request and verifies the answer.
GET/scim/v2/GroupsList groups
POST/scim/v2/GroupsCreate a group
GET/scim/v2/Groups/{id}Get one group
PUT/scim/v2/Groups/{id}Replace one group
PATCH/scim/v2/Groups/{id}Update one group
DELETE/scim/v2/Groups/{id}Delete one group
GET/scim/v2/SchemasList schemas
GET/scim/v2/Schemas/{id}Get one schema
GET/scim/v2/ServiceProviderConfigList service provider config
GET/scim/v2/UsersList users
POST/scim/v2/UsersCreate a user
GET/scim/v2/Users/{id}Get one user
PUT/scim/v2/Users/{id}Replace one user
PATCH/scim/v2/Users/{id}Update one user
DELETE/scim/v2/Users/{id}Delete one user
GET/social/{organization_id}/{provider}/callbackCallback of a {organization id}
GET/social/{organization_id}/{provider}/loginLogin of a {organization id}

Endpoints

POST /api/v1/svc/sso/AcceptDomainTransfer

Accept domain transfer

Permission
sso.domains:acceptdomaintransfer
Request body
transferIDIn

POST /api/v1/svc/sso/ActivateConnectionRevision

Activate connection revision

Permission
sso.connections:activateconnectionrevision
Request body
activateIn

POST /api/v1/svc/sso/CancelDomainTransfer

Cancel domain transfer

Permission
sso.domains:canceldomaintransfer
Request body
transferIDIn

POST /api/v1/svc/sso/CheckConnectionRegistration

Asks the identity provider whether it accepts the connection's client authentication (a token request with a placeholder code; nobody is signed in and no token is issued). Audited with its result; at most 10 a minute per connection.

Permission
sso.connections:checkconnectionregistration
Request body
checkRegistrationIn

POST /api/v1/svc/sso/ConfirmEmergencyAdmin

Confirm emergency admin

Permission
signed in
Request body
object

POST /api/v1/svc/sso/ContestDomainClaim

Contest domain claim

Permission
sso.domains:contestdomainclaim
Request body
object

POST /api/v1/svc/sso/CreateAccountAssignment

Create account assignment

Permission
sso.assignments:createaccountassignment
Request body
assignmentIn

POST /api/v1/svc/sso/CreateConnection

Create connection

Permission
sso.connections:createconnection
Request body
createConnectionIn

POST /api/v1/svc/sso/CreateDomainClaim

Create domain claim

Permission
sso.domains:createdomainclaim
Request body
object

POST /api/v1/svc/sso/CreateGroupMapping

Create group mapping

Permission
sso.mappings:creategroupmapping
Request body
object

POST /api/v1/svc/sso/CreatePermissionSet

Create permission set

Permission
sso.permissionsets:createpermissionset
Request body
object

POST /api/v1/svc/sso/DeleteAccountAssignment

Delete account assignment

Permission
sso.assignments:deleteaccountassignment
Request body
assignmentIn

POST /api/v1/svc/sso/DeleteConnection

Delete connection

Permission
sso.connections:deleteconnection
Request body
connectionIDIn

POST /api/v1/svc/sso/DeleteDomainClaim

Delete domain claim

Permission
sso.domains:deletedomainclaim
Request body
claimIDIn

POST /api/v1/svc/sso/DeleteGroupMapping

Delete group mapping

Permission
sso.mappings:deletegroupmapping
Request body
object

POST /api/v1/svc/sso/DeletePermissionSet

Delete permission set

Permission
sso.permissionsets:deletepermissionset
Request body
object

POST /api/v1/svc/sso/DescribeConnection

Describe connection

Permission
sso.connections:describeconnection
Request body
connectionIDIn

POST /api/v1/svc/sso/DescribeDomainClaim

Describe domain claim

Permission
sso.domains:describedomainclaim
Request body
claimIDIn

POST /api/v1/svc/sso/DescribeInstance

Describe instance

Permission
sso.instances:describeinstance
Request body
object

POST /api/v1/svc/sso/DescribePermissionSetProvisioningStatus

Describe permission set provisioning status

Permission
sso.permissionsets:describepermissionsetprovisioningstatus
Request body
object

POST /api/v1/svc/sso/DisableConnection

Disable connection

Permission
sso.connections:disableconnection
Request body
connectionIDIn

POST /api/v1/svc/sso/EnableConnectionIdpMfaTrust

Trusts the IdP's MFA instead of Sandscale's second factor at sign-in through the connection's active revision, with the policy's stored amr and acr values. Its route's re-verification is sso.idp_mfa_trust:enable; the handler refuses a caller that is not a person's own session again, a connection without an active revision, and an active revision whose latest passing test did not assert MFA by Sandscale's reading with those values. Audited with before and after, refusals too.

Permission
sso.sessions:enableconnectionidpmfatrust
Request body
connectionIDIn

POST /api/v1/svc/sso/GetConnectionSessionPolicy

Get connection session policy

Permission
sso.sessions:getconnectionsessionpolicy
Request body
connectionIDIn

POST /api/v1/svc/sso/GetConnectionSetup

Get connection setup

Permission
sso.connections:getconnectionsetup
Request body
object

POST /api/v1/svc/sso/GetConnectionTestResult

Get connection test result

Permission
sso.connections:getconnectiontestresult
Request body
object

POST /api/v1/svc/sso/GetDomainEnforcement

Get domain enforcement

Permission
sso.enforcement:getdomainenforcement
Request body
object

POST /api/v1/svc/sso/GetJitRules

Get jit rules

Permission
sso.mappings:getjitrules
Request body
object

POST /api/v1/svc/sso/GetMyDomainStatus

Get my domain status

Permission
signed in
Request body
object

POST /api/v1/svc/sso/GetServiceProviderMetadata

Get service provider metadata

Permission
sso.connections:getserviceprovidermetadata
Request body
object

POST /api/v1/svc/sso/ImportIdentityProviderMetadata

Import identity provider metadata

Permission
sso.connections:importidentityprovidermetadata
Request body
object

POST /api/v1/svc/sso/LinkTestIdentity

Links the identity of the caller's own passing test sign-in to the caller's login. The route is a sensitive action (sso.identity:link: one factor, people only), so the caller re-verified before it runs; every condition is checked again here under a lock of the test, and the link, its record as the caller's sign-in through the connection and the audit entry are one transaction. A refusal is audited.

Permission
sso.connections:linktestidentity
Request body
linkTestIn

POST /api/v1/svc/sso/ListAccountAssignments

List account assignments

Permission
sso.assignments:listaccountassignments
Request body
object

POST /api/v1/svc/sso/ListConnections

List connections

Permission
sso.connections:listconnections
Request body
listConnectionsIn

POST /api/v1/svc/sso/ListDomainClaims

List domain claims

Permission
sso.domains:listdomainclaims
Request body
object

POST /api/v1/svc/sso/ListDomainTransfers

List domain transfers

Permission
sso.domains:listdomaintransfers
Request body
object

POST /api/v1/svc/sso/ListDomainUsers

List domain users

Permission
sso.domainusers:listdomainusers
Request body
object

POST /api/v1/svc/sso/ListEmergencyAdmins

List emergency admins

Permission
sso.enforcement:listemergencyadmins
Request body
object

POST /api/v1/svc/sso/ListGroupMappings

List group mappings

Permission
sso.mappings:listgroupmappings
Request body
object

POST /api/v1/svc/sso/ListPermissionSets

List permission sets

Permission
sso.permissionsets:listpermissionsets
Request body
object

POST /api/v1/svc/sso/PreviewHomeRealmDiscovery

Preview home realm discovery

Permission
sso.enforcement:previewhomerealmdiscovery
Request body
object

POST /api/v1/svc/sso/PutConnectionSessionPolicy

Put connection session policy

Permission
sso.sessions:putconnectionsessionpolicy
Request body
putSessionPolicyIn

POST /api/v1/svc/sso/PutDomainEnforcement

Put domain enforcement

Permission
sso.enforcement:putdomainenforcement
Request body
object

POST /api/v1/svc/sso/PutDomainUserAction

Put domain user action

Permission
sso.domainusers:putdomainuseraction
Request body
object

POST /api/v1/svc/sso/PutEmergencyAdmins

Put emergency admins

Permission
sso.enforcement:putemergencyadmins
Request body
object

POST /api/v1/svc/sso/PutJitRules

Put jit rules

Permission
sso.mappings:putjitrules
Request body
object

POST /api/v1/svc/sso/RecheckDomainClaim

Recheck domain claim

Permission
sso.domains:recheckdomainclaim
Request body
claimIDIn

POST /api/v1/svc/sso/RotateServiceProviderCertificate

Rotate service provider certificate

Permission
sso.connections:rotateserviceprovidercertificate
Request body
object

POST /api/v1/svc/sso/StartConnectionTest

Start connection test

Permission
sso.connections:startconnectiontest
Request body
startTestIn

POST /api/v1/svc/sso/StartDomainTransfer

Start domain transfer

Permission
sso.domains:startdomaintransfer
Request body
object

POST /api/v1/svc/sso/StartSessionReauthentication

Starts the caller's re-authentication at the IdP its session was issued through. It acts on the caller's own session only; a session not issued through a connection (a password, passkey or root session, or an API key) is refused: its step-up is Sandscale's own second factor.

Permission
signed in
Request body
object

POST /api/v1/svc/sso/UpdateConnection

Update connection

Permission
sso.connections:updateconnection
Request body
updateConnectionIn

POST /api/v1/svc/sso/UpdatePermissionSet

Update permission set

Permission
sso.permissionsets:updatepermissionset
Request body
object

POST /api/v1/svc/sso/VerifyDomainClaim

Verify domain claim

Permission
sso.domains:verifydomainclaim
Request body
claimIDIn

GET /oidc/{organization_id}/callback

Callback of an oidc

Permission
none
Path parameters
organization_id
Query parameters
state

GET /oidc/{organization_id}/login

And oidcCallback serve the legacy URLs of the organization's OIDC connection: Identity Center builds the request and verifies the answer.

Permission
none
Path parameters
organization_id

GET /scim/v2/Groups

List groups

Permission
none
Query parameters
count, filter, startIndex
Errors
409: mutability, uniqueness

POST /scim/v2/Groups

Create a group

Permission
none
Request body
SCIMGroup
Errors
409: mutability, uniqueness

GET /scim/v2/Groups/{id}

Get one group

Permission
none
Path parameters
id
Errors
409: mutability, uniqueness

PUT /scim/v2/Groups/{id}

Replace one group

Permission
none
Path parameters
id
Request body
SCIMGroup
Errors
409: mutability, uniqueness

PATCH /scim/v2/Groups/{id}

Update one group

Permission
none
Path parameters
id
Request body
ProvisioningPatchRequest
Errors
409: mutability, uniqueness

DELETE /scim/v2/Groups/{id}

Delete one group

Permission
none
Path parameters
id
Errors
409: mutability, uniqueness

GET /scim/v2/Schemas

List schemas

Permission
none
Response
200: object of any

GET /scim/v2/Schemas/{id}

Get one schema

Permission
none
Path parameters
id
Response
200: object of any

GET /scim/v2/ServiceProviderConfig

List service provider config

Permission
none
Response
200: object of any

GET /scim/v2/Users

List users

Permission
none
Query parameters
count, filter, startIndex
Response
200: UserListResponse
Errors
409: mutability, uniqueness

POST /scim/v2/Users

Create a user

Permission
none
Request body
SCIMUser
Response
201: SCIMUser
Errors
409: mutability, uniqueness

GET /scim/v2/Users/{id}

Get one user

Permission
none
Path parameters
id
Response
200: SCIMUser
Errors
409: mutability, uniqueness

PUT /scim/v2/Users/{id}

Replace one user

Permission
none
Path parameters
id
Request body
SCIMUser
Response
200: SCIMUser
Errors
409: mutability, uniqueness

PATCH /scim/v2/Users/{id}

Update one user

Permission
none
Path parameters
id
Request body
ProvisioningPatchRequest
Response
200: SCIMUser
Errors
409: mutability, uniqueness

DELETE /scim/v2/Users/{id}

Delete one user

Permission
none
Path parameters
id
Errors
409: mutability, uniqueness

GET /social/{organization_id}/{provider}/callback

Callback of a {organization id}

Permission
none
Path parameters
organization_id, provider
Query parameters
code, error, state

GET /social/{organization_id}/{provider}/login

Login of a {organization id}

Permission
none
Path parameters
organization_id, provider
Query parameters
handle

Objects

object

FieldTypeDescription
Tokenstring

object

FieldTypeDescription
Domainstring
IncludeSubdomains optionalboolean

object

FieldTypeDescription
Domainstring
Methodstring
IncludeSubdomains optionalboolean

object

FieldTypeDescription
ConnectionIdstring
Sourcestring
Targethttpapi.mappingTargetIn

object

FieldTypeDescription
Namestring
Descriptionstring
SessionDurationstring
AccountRolestring
CustomerRoleNamestring
RelayStatestring

object

FieldTypeDescription
MappingIdstring

object

FieldTypeDescription
PermissionSetArnstring

object

No fields.

object

FieldTypeDescription
PermissionSetArnstring

object

FieldTypeDescription
ConnectionIdstring

object

FieldTypeDescription
ConnectionIdstring
TestIdstring

object

No fields.

object

FieldTypeDescription
ConnectionIdstring

object

No fields.

object

FieldTypeDescription
ConnectionIdstring
Revisioninteger

object

FieldTypeDescription
ConnectionIdstring
MetadataUrlstring
MetadataXmlstring

object

FieldTypeDescription
AccountIdstring
PermissionSetArnstring
MaxResultsinteger
NextTokenstring

object

FieldTypeDescription
MaxResultsinteger
NextTokenstring

object

No fields.

object

FieldTypeDescription
ClaimIdstring
MaxResults optionalinteger
NextToken optionalstring

object

No fields.

object

FieldTypeDescription
ConnectionIdstring
MaxResultsinteger
NextTokenstring

object

FieldTypeDescription
MaxResultsinteger
NextTokenstring

object

FieldTypeDescription
Emailstring

object

FieldTypeDescription
ClaimIdstring
Modestring
ConnectionId optionalstring
EffectiveDate optionalstring
GracePeriodHours optionalinteger

object

FieldTypeDescription
ClaimIdstring
UserIdstring
Actionstring
AccountId optionalstring
RoleId optionalstring

object

FieldTypeDescription
UserIdsarray of string
MfaCode optionalstring

object

FieldTypeDescription
ConnectionIdstring
Enabledboolean
JitWithScimboolean
DefaultPermissionSetArnstring
DefaultAccountIdstring

object

FieldTypeDescription
ConnectionIdstring
Usestring
Stagestring

object

FieldTypeDescription
ClaimIdstring
TargetAccountIdstring
MfaCode optionalstring

object

No fields.

object

FieldTypeDescription
PermissionSetArnstring
Description optionalstring
SessionDuration optionalstring
AccountRole optionalstring
CustomerRoleName optionalstring

activateIn

FieldTypeDescription
ConnectionIdstring
Revisioninteger

assignmentIn

AssignmentIn names an account assignment.

FieldTypeDescription
PermissionSetArnstring
PrincipalTypestring
PrincipalIdstring
TargetIdstring
TargetTypestring

checkRegistrationIn

FieldTypeDescription
ConnectionIdstring
RevisionintegerThe revision to check: the draft when 0, else the active revision.

claimIDIn

FieldTypeDescription
ClaimIdstring

connectionIDIn

FieldTypeDescription
ConnectionIdstring

createConnectionIn

FieldTypeDescription
Namestring
Protocolstring
Presetstring
SettingsJSON

linkTestIn

FieldTypeDescription
ConnectionIdstring
TestIdstring
FinishbooleanFinish: "Link and finish". With the link, the same request activates the draft revision the test passed, when the caller may activate it and the test passes the real sign-in readiness; one re-verification covers both. Anything unmet refuses the whole request and links nothing.

listConnectionsIn

FieldTypeDescription
Statestring
NextTokenstring
MaxResultsinteger

mappingTargetIn

A group mapping's target as the action receives it.

FieldTypeDescription
Typestring
PermissionSetArnstring
AccountIdsarray of string
AccountIdstring
AccountRolestring
CustomerRoleNamestring
ProjectIdstring
ProjectRolestring

putSessionPolicyIn

FieldTypeDescription
ConnectionIdstring
MaxSessionMinutes optionalinteger
IdleTimeoutMinutes optionalinteger
ReauthenticationWindowMinutes optionalinteger
RequireIdpMfaForAdminboolean
IdpMfaAmrValuesarray of string
IdpMfaAcrValuesarray of string
TrustIdpMfabooleanTrustIdpMfa asks that the IdP's MFA stand in for Sandscale's second factor at sign-in.

startTestIn

FieldTypeDescription
ConnectionIdstring
RevisionintegerThe revision to test: the draft when 0, else the active revision.

transferIDIn

FieldTypeDescription
TransferIdstring

updateConnectionIn

FieldTypeDescription
ConnectionIdstring
Name optionalstring
SettingsJSON
DiscardDraftbooleanDiscardDraft discards the draft revision (the active one keeps serving).

PatchOp

A single operation within a SCIM PATCH request (RFC 7644 §3.5.2).

FieldTypeDescription
opstring
path optionalstring
value optionalJSON

ProvisioningPatchRequest

The envelope for a SCIM PATCH body.

FieldTypeDescription
schemasarray of string
Operationsarray of PatchOp

SCIMEmail

SCIMEmail represents a single entry in the emails multi-value attribute.

FieldTypeDescription
valuestring
type optionalstring
primary optionalboolean

SCIMEnterpriseUser

The enterprise extension of a user.

FieldTypeDescription
employeeNumber optionalstring
costCenter optionalstring
organization optionalstring
division optionalstring
department optionalstring
manager optionalSCIMManager

SCIMGroup

The SCIM 2.0 Group resource representation.

FieldTypeDescription
schemasarray of string
id optionalstring
externalId optionalstring
displayNamestring
members optionalarray of SCIMGroupMember
meta optionalSCIMMeta

SCIMGroupMember

One entry of a SCIM group's members attribute. Type is "User" or "Group"; a member whose $ref names a Group is a group.

FieldTypeDescription
valuestring
$ref optionalstring
display optionalstring
type optionalstring

SCIMManager

The manager attribute of the enterprise extension.

FieldTypeDescription
value optionalstring
$ref optionalstring
displayName optionalstring

SCIMMeta

SCIMMeta contains the read-only metadata block every SCIM resource carries.

FieldTypeDescription
resourceType optionalstring
created optionalstring
lastModified optionalstring
location optionalstring
version optionalstring

SCIMName

The name attribute of a user.

FieldTypeDescription
formatted optionalstring
familyName optionalstring
givenName optionalstring
middleName optionalstring
honorificPrefix optionalstring
honorificSuffix optionalstring

SCIMUser

The full SCIM 2.0 User resource representation.

FieldTypeDescription
schemasarray of string
id optionalstring
externalId optionalstring
userNamestring
nameSCIMName
emails optionalarray of SCIMEmail
activeboolean
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User optionalSCIMEnterpriseUserThe enterprise extension. It is written to the user's Directory profile and not returned.
meta optionalSCIMMeta

UserListResponse

FieldTypeDescription
schemasarray of string
totalResultsinteger
startIndexinteger
itemsPerPageinteger
Resourcesarray of SCIMUser

This page is generated from the server's route table and the Go handlers that serve each route. Do not edit it by hand.