srinivasanagandla-okta/gist:d2fa700981b236a67321 Secret

Last active April 3, 2019 05:31

Star (1) You must be signed in to star a gist
Fork (0) You must be signed in to fork a gist

Learn more about clone URLs
Clone this repository at <script src="https://gist.github.com/srinivasanagandla-okta/d2fa700981b236a67321.js"></script>
Save srinivasanagandla-okta/d2fa700981b236a67321 to your computer and use it in GitHub Desktop.

Download ZIP

MFA Objects

Raw

gistfile1.md

Device Types

Type	Description
orn:okta:factor:device:computer	Computer (Desktop/Laptop)
orn:okta:factor:device:phone	Regular Phone
orn:okta:factor:device:phone:mobile	Cell Phone
orn:okta:factor:device:hardware_token	Hardware Token
orn:okta:factor:device:phone:smartphone:ios	IPhone
orn:okta:factor:device:phone:smartphone:android	Android Phone
orn:okta:factor:device:phone:smartphone:windows	Windows Phone
orn:okta:factor:device:phone:smartphone:blackberry	BlackBerry Phone
orn:okta:factor:device:tablet:ios	IOS Tablet
orn:okta:factor:device:tablet:android	Android Tablet
orn:okta:factor:device:tablet:windows	Windows Tablet

Factor Types

Type	Description
orn:okta:factor:types:sms	SMS
orn:okta:factor:types:call	Call
orn:okta:factor:types:hotp	Hardware Token
orn:okta:factor:types:sotp	Software Token
orn:okta:factor:types:question	Question

Factor Providers

Provider	Description
orn:okta:factor:provider:okta	Okta
orn:okta:factor:provider:rsa	Okta RSA Integration
orn:okta:factor:provider:symantec	Okta Symantec Integration
orn:okta:factor:provider:google	Okta Google Integration

_links

LinkName	Description
self	Link to the current user factor info
activate	Link to activation
deactivate	Link to deactivation
user	Link to User Info
provider	Link to Provider Info
barcode	Activation Links to barcode/QR Code
appStore	Links to AppStore to download/install the Related App

self

Attribute	Description
href	link to self
hints	Allowed methods

activate

Attribute	Description
href	link to activate API
hints	Allowed methods

deactivate

Attribute	Description
href	link to deactivate API
hints	Allowed methods

user

Attribute	Description
href	link to User Info
hints	Allowed methods

provider

Attribute	Description
href	link to Provider Info
hints	Allowed methods

barcode

Attribute	Description
href	Device specific Activation Link
deviceType	Device Type

appStore

Attribute	Description
href	Device specific AppStore Link
deviceType	Device Type

_embedded

Object Name	Description
verify	Verification details
sync	Sync Details

verify Object

Attribute	Description	Data Type
type	Type of verification code (passcode, answer etc)
count	Number of verification codes

sync Object

Attribute	Description	Data Type
supportsSync	Indicates whether sync is supported	boolean
noOfSyncCodes	Number of sync codes required	int

MFA User Profile

To enroll for a factor, appropriate profile information has to be supplied.

Following is an enumeration of profiles based on the factor type

SMS/Call Profile

Parameter	Description	Param Type	DataType	Required	Default
deviceName	Name of the Device	Body	String	Yes
countryCode	Country Code used for dialing	Body	String	Yes	+1
phoneNumber	Phone number of the cell-phone	Body	String	Yes

Hardware/Software Token Profile (Okta, Google, Symantec VIP, RSA etc)

Parameter	Description	Param Type	DataType	Required	Default
deviceName	Name of the Device	Body	String	Yes
credentialID	Credential Id (UserId)	Body	String	Optional	Okta UserName

Security Question Profile

Parameter	Description	Param Type	DataType	Required	Default
question1	Id of the Question	Body	String	Yes
answer1	Answer for the question	Body	String	Yes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment