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
| Method | Path | What it does |
|---|---|---|
POST | /api/v1/svc/sso/AcceptDomainTransfer | Accept domain transfer |
POST | /api/v1/svc/sso/ActivateConnectionRevision | Activate connection revision |
POST | /api/v1/svc/sso/CancelDomainTransfer | Cancel domain transfer |
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. |
POST | /api/v1/svc/sso/ConfirmEmergencyAdmin | Confirm emergency admin |
POST | /api/v1/svc/sso/ContestDomainClaim | Contest domain claim |
POST | /api/v1/svc/sso/CreateAccountAssignment | Create account assignment |
POST | /api/v1/svc/sso/CreateConnection | Create connection |
POST | /api/v1/svc/sso/CreateDomainClaim | Create domain claim |
POST | /api/v1/svc/sso/CreateGroupMapping | Create group mapping |
POST | /api/v1/svc/sso/CreatePermissionSet | Create permission set |
POST | /api/v1/svc/sso/DeleteAccountAssignment | Delete account assignment |
POST | /api/v1/svc/sso/DeleteConnection | Delete connection |
POST | /api/v1/svc/sso/DeleteDomainClaim | Delete domain claim |
POST | /api/v1/svc/sso/DeleteGroupMapping | Delete group mapping |
POST | /api/v1/svc/sso/DeletePermissionSet | Delete permission set |
POST | /api/v1/svc/sso/DescribeConnection | Describe connection |
POST | /api/v1/svc/sso/DescribeDomainClaim | Describe domain claim |
POST | /api/v1/svc/sso/DescribeInstance | Describe instance |
POST | /api/v1/svc/sso/DescribePermissionSetProvisioningStatus | Describe permission set provisioning status |
POST | /api/v1/svc/sso/DisableConnection | Disable connection |
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. |
POST | /api/v1/svc/sso/GetConnectionSessionPolicy | Get connection session policy |
POST | /api/v1/svc/sso/GetConnectionSetup | Get connection setup |
POST | /api/v1/svc/sso/GetConnectionTestResult | Get connection test result |
POST | /api/v1/svc/sso/GetDomainEnforcement | Get domain enforcement |
POST | /api/v1/svc/sso/GetJitRules | Get jit rules |
POST | /api/v1/svc/sso/GetMyDomainStatus | Get my domain status |
POST | /api/v1/svc/sso/GetServiceProviderMetadata | Get service provider metadata |
POST | /api/v1/svc/sso/ImportIdentityProviderMetadata | Import identity provider metadata |
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. |
POST | /api/v1/svc/sso/ListAccountAssignments | List account assignments |
POST | /api/v1/svc/sso/ListConnections | List connections |
POST | /api/v1/svc/sso/ListDomainClaims | List domain claims |
POST | /api/v1/svc/sso/ListDomainTransfers | List domain transfers |
POST | /api/v1/svc/sso/ListDomainUsers | List domain users |
POST | /api/v1/svc/sso/ListEmergencyAdmins | List emergency admins |
POST | /api/v1/svc/sso/ListGroupMappings | List group mappings |
POST | /api/v1/svc/sso/ListPermissionSets | List permission sets |
POST | /api/v1/svc/sso/PreviewHomeRealmDiscovery | Preview home realm discovery |
POST | /api/v1/svc/sso/PutConnectionSessionPolicy | Put connection session policy |
POST | /api/v1/svc/sso/PutDomainEnforcement | Put domain enforcement |
POST | /api/v1/svc/sso/PutDomainUserAction | Put domain user action |
POST | /api/v1/svc/sso/PutEmergencyAdmins | Put emergency admins |
POST | /api/v1/svc/sso/PutJitRules | Put jit rules |
POST | /api/v1/svc/sso/RecheckDomainClaim | Recheck domain claim |
POST | /api/v1/svc/sso/RotateServiceProviderCertificate | Rotate service provider certificate |
POST | /api/v1/svc/sso/StartConnectionTest | Start connection test |
POST | /api/v1/svc/sso/StartDomainTransfer | Start domain transfer |
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. |
POST | /api/v1/svc/sso/UpdateConnection | Update connection |
POST | /api/v1/svc/sso/UpdatePermissionSet | Update permission set |
POST | /api/v1/svc/sso/VerifyDomainClaim | Verify domain claim |
GET | /oidc/{organization_id}/callback | Callback of an oidc |
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. |
GET | /scim/v2/Groups | List groups |
POST | /scim/v2/Groups | Create 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/Schemas | List schemas |
GET | /scim/v2/Schemas/{id} | Get one schema |
GET | /scim/v2/ServiceProviderConfig | List service provider config |
GET | /scim/v2/Users | List users |
POST | /scim/v2/Users | Create 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}/callback | Callback of a {organization id} |
GET | /social/{organization_id}/{provider}/login | Login 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
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
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
| Field | Type | Description |
|---|---|---|
Token | string |
object
| Field | Type | Description |
|---|---|---|
Domain | string | |
IncludeSubdomains optional | boolean |
object
| Field | Type | Description |
|---|---|---|
Domain | string | |
Method | string | |
IncludeSubdomains optional | boolean |
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Source | string | |
Target | httpapi.mappingTargetIn |
object
| Field | Type | Description |
|---|---|---|
Name | string | |
Description | string | |
SessionDuration | string | |
AccountRole | string | |
CustomerRoleName | string | |
RelayState | string |
object
| Field | Type | Description |
|---|---|---|
MappingId | string |
object
| Field | Type | Description |
|---|---|---|
PermissionSetArn | string |
object
No fields.
object
| Field | Type | Description |
|---|---|---|
PermissionSetArn | string |
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string |
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
TestId | string |
object
No fields.
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string |
object
No fields.
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Revision | integer |
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
MetadataUrl | string | |
MetadataXml | string |
object
| Field | Type | Description |
|---|---|---|
AccountId | string | |
PermissionSetArn | string | |
MaxResults | integer | |
NextToken | string |
object
| Field | Type | Description |
|---|---|---|
MaxResults | integer | |
NextToken | string |
object
No fields.
object
| Field | Type | Description |
|---|---|---|
ClaimId | string | |
MaxResults optional | integer | |
NextToken optional | string |
object
No fields.
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
MaxResults | integer | |
NextToken | string |
object
| Field | Type | Description |
|---|---|---|
MaxResults | integer | |
NextToken | string |
object
| Field | Type | Description |
|---|---|---|
Email | string |
object
| Field | Type | Description |
|---|---|---|
ClaimId | string | |
Mode | string | |
ConnectionId optional | string | |
EffectiveDate optional | string | |
GracePeriodHours optional | integer |
object
| Field | Type | Description |
|---|---|---|
ClaimId | string | |
UserId | string | |
Action | string | |
AccountId optional | string | |
RoleId optional | string |
object
| Field | Type | Description |
|---|---|---|
UserIds | array of string | |
MfaCode optional | string |
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Enabled | boolean | |
JitWithScim | boolean | |
DefaultPermissionSetArn | string | |
DefaultAccountId | string |
object
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Use | string | |
Stage | string |
object
| Field | Type | Description |
|---|---|---|
ClaimId | string | |
TargetAccountId | string | |
MfaCode optional | string |
object
No fields.
object
| Field | Type | Description |
|---|---|---|
PermissionSetArn | string | |
Description optional | string | |
SessionDuration optional | string | |
AccountRole optional | string | |
CustomerRoleName optional | string |
activateIn
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Revision | integer |
assignmentIn
AssignmentIn names an account assignment.
| Field | Type | Description |
|---|---|---|
PermissionSetArn | string | |
PrincipalType | string | |
PrincipalId | string | |
TargetId | string | |
TargetType | string |
checkRegistrationIn
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Revision | integer | The revision to check: the draft when 0, else the active revision. |
claimIDIn
| Field | Type | Description |
|---|---|---|
ClaimId | string |
connectionIDIn
| Field | Type | Description |
|---|---|---|
ConnectionId | string |
createConnectionIn
| Field | Type | Description |
|---|---|---|
Name | string | |
Protocol | string | |
Preset | string | |
Settings | JSON |
linkTestIn
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
TestId | string | |
Finish | boolean | Finish: "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
| Field | Type | Description |
|---|---|---|
State | string | |
NextToken | string | |
MaxResults | integer |
mappingTargetIn
A group mapping's target as the action receives it.
| Field | Type | Description |
|---|---|---|
Type | string | |
PermissionSetArn | string | |
AccountIds | array of string | |
AccountId | string | |
AccountRole | string | |
CustomerRoleName | string | |
ProjectId | string | |
ProjectRole | string |
putSessionPolicyIn
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
MaxSessionMinutes optional | integer | |
IdleTimeoutMinutes optional | integer | |
ReauthenticationWindowMinutes optional | integer | |
RequireIdpMfaForAdmin | boolean | |
IdpMfaAmrValues | array of string | |
IdpMfaAcrValues | array of string | |
TrustIdpMfa | boolean | TrustIdpMfa asks that the IdP's MFA stand in for Sandscale's second factor at sign-in. |
startTestIn
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Revision | integer | The revision to test: the draft when 0, else the active revision. |
transferIDIn
| Field | Type | Description |
|---|---|---|
TransferId | string |
updateConnectionIn
| Field | Type | Description |
|---|---|---|
ConnectionId | string | |
Name optional | string | |
Settings | JSON | |
DiscardDraft | boolean | DiscardDraft discards the draft revision (the active one keeps serving). |
PatchOp
A single operation within a SCIM PATCH request (RFC 7644 §3.5.2).
| Field | Type | Description |
|---|---|---|
op | string | |
path optional | string | |
value optional | JSON |
ProvisioningPatchRequest
The envelope for a SCIM PATCH body.
| Field | Type | Description |
|---|---|---|
schemas | array of string | |
Operations | array of PatchOp |
SCIMEmail
SCIMEmail represents a single entry in the emails multi-value attribute.
| Field | Type | Description |
|---|---|---|
value | string | |
type optional | string | |
primary optional | boolean |
SCIMEnterpriseUser
The enterprise extension of a user.
| Field | Type | Description |
|---|---|---|
employeeNumber optional | string | |
costCenter optional | string | |
organization optional | string | |
division optional | string | |
department optional | string | |
manager optional | SCIMManager |
SCIMGroup
The SCIM 2.0 Group resource representation.
| Field | Type | Description |
|---|---|---|
schemas | array of string | |
id optional | string | |
externalId optional | string | |
displayName | string | |
members optional | array of SCIMGroupMember | |
meta optional | SCIMMeta |
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.
| Field | Type | Description |
|---|---|---|
value | string | |
$ref optional | string | |
display optional | string | |
type optional | string |
SCIMManager
The manager attribute of the enterprise extension.
| Field | Type | Description |
|---|---|---|
value optional | string | |
$ref optional | string | |
displayName optional | string |
SCIMMeta
SCIMMeta contains the read-only metadata block every SCIM resource carries.
| Field | Type | Description |
|---|---|---|
resourceType optional | string | |
created optional | string | |
lastModified optional | string | |
location optional | string | |
version optional | string |
SCIMName
The name attribute of a user.
| Field | Type | Description |
|---|---|---|
formatted optional | string | |
familyName optional | string | |
givenName optional | string | |
middleName optional | string | |
honorificPrefix optional | string | |
honorificSuffix optional | string |
SCIMUser
The full SCIM 2.0 User resource representation.
| Field | Type | Description |
|---|---|---|
schemas | array of string | |
id optional | string | |
externalId optional | string | |
userName | string | |
name | SCIMName | |
emails optional | array of SCIMEmail | |
active | boolean | |
urn:ietf:params:scim:schemas:extension:enterprise:2.0:User optional | SCIMEnterpriseUser | The enterprise extension. It is written to the user's Directory profile and not returned. |
meta optional | SCIMMeta |
UserListResponse
| Field | Type | Description |
|---|---|---|
schemas | array of string | |
totalResults | integer | |
startIndex | integer | |
itemsPerPage | integer | |
Resources | array 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.