Skip to main content

⏰ Getting Started

Introduction

Soffid allows you to combine two of the most powerfull powerful addons that you can use into Soffid Console, SCIMSCIM, and OTPFederation

Please note that the SCIM REST Web Service Add-on installed must be installed, please check this part in How to use SCIM in Soffid # Installation

Please note that a user with the authentication is required, please check this part in How to use SCIM in Soffid # Confirm authorization

Please note that it is recommended to use a REST client, please see our example in Testing tool # RESTer

Please note that the correct header parameters must be used, please browse them in SCIM in Soffid # HTTP request

Please note that OTPthe Federation addon must be intalledinstalled and configured,  check it in OTPthe SettingsFederation book.

OTPIdentify DeviceService Provider

  • classe: "S"

Service providers Types

OTPService deviceproviders types available 

  • TOTPSAML: Time based HMAC Tokensaml
  • HOTPSAML API client: Event based HMAC Tokensoffid-saml
  • EMAILOpenID Connect: openid-connect
  • SMSOpenID Dynamic Register: openid-dynamic-register
  • PINRadius client: Securityradius
  • PIN
  • CAS client: cas

OTPOpen DeviceId StatusMechanism

OTP device status available :

  • C:PA: CreatedUser's password
  • V:AC: ValidatedAuthorization code
  • L:PC: LockedUser's password + Client credentials
  • D:IM: DisabledImplicit

OTPFederation  Operations

Soffid provides an API that allows you to connect to the OTPFederation microservices.

The available operations are the following

  • List all 
  • List by filter
  • Query by id
  • Create
  • Update
  • Validate
  • Send SMS
  • Delete

You can visit the SCIM OTPFederation devicesMember examples and the SCIM Entity Group examples page  for more detailed information

Workflows

With the previous operations, using the SCIM OTP API, we can define some workflows.

You can visit the SCIM OTP devices Workflows examples pageinformation.