Skip to main content

Getting Started

Introduction

Soffid allows you to combine two of the most powerful addons you can use into Soffid Console, SCIM, and OTP

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 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 the OTP addon must be installed and configured,  check it in OTP Settings

OTP Device Types

OTP device types available 

  • TOTP: Time based HMAC Token
  • HOTP: Event based HMAC Token
  • EMAIL
  • SMS
  • PIN: Security PIN

OTP Device Status

OTP device status available :

  • C: Created
  • V: Validated
  • L: Locked
  • D: Disabled

OTP Operations

Soffid provides an API that allows you to connect to the OTP 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 OTP devices 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 page