Login API
{ http://soa.com/wsdl/login/1.0 } LoginAPI
The Login service provides a REST interface and a set of operations that deal with logging in and out, including getting an authentication token, renewing an authorization token, and deleting an authorization token cookie. This API also includes interfaces to perform SSO login.
POSTlogin
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
loginRequest
loginRequest {
federationLogins( boolean, required )
fedMemberId( string )
password( string )
authToken( string )
domainName( string )
userName( string )
email( string )
invitationCode( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
loginResponse
loginResponse {
pendingTasks( Collection of string )
loginState( string )
avatarURL( string )
authToken( string )
lastLoginDate( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
pendingAgreements( Collection of string )
csrfToken( string )
pendingTaskData( anyType )
authTokenValidUntil( string )
sessionValidUntil( string )
status( string )
userFDN( string )
}
GET/domainsgetLoginDomains
Parameters
Name
Type
Description
Model
all
query
boolean
IncludeDisabled
query
boolean
cache
query
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
LoginDomain
LoginDomain {
DisplayMode( string )
FedmemberId( string )
LogoAssigned( boolean )
DomainName( string )
IdSystemType( string )
Title( string )
Enabled( boolean )
LogoId( long )
LoginDomainID( string )
Sequence( int )
VirtualHost( Collection of string )
}
PUT/domainsupdateLoginDomains
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
LoginDomains
LoginDomains {
LoginDomain {
LoginDomain( Collection of LoginDomain, required )
}
LoginDomain {
DisplayMode( string, required )
FedmemberId( string, required )
LogoAssigned( boolean, required )
DomainName( string, required )
IdSystemType( string, required )
Title( string, required )
Enabled( boolean, required )
LogoId( long )
LoginDomainID( string )
Sequence( int, required )
VirtualHost( Collection of string, required )
}
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/statusgetLoginStatus
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
loginResponse
loginResponse {
pendingTasks( Collection of string )
loginState( string )
avatarURL( string )
authToken( string )
lastLoginDate( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
pendingAgreements( Collection of string )
csrfToken( string )
pendingTaskData( anyType )
authTokenValidUntil( string )
sessionValidUntil( string )
status( string )
userFDN( string )
}
POST/validateRegistrationCodevalidateRegistrationCode
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
registrationCode
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/endsessionendSession
Parameters
Name
Type
Description
Model
returninstructions
query
boolean
event
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/ssologoutprocessLogoutGet
Reponse
Produces */*
Status Code
Reason
Model
200
Success
any
POST/ssologoutprocessLogoutPost
Reponse
Produces */*
Status Code
Reason
Model
200
Success
any
POST/pendingtasksresolveLoginPendingTask
Parameters
Accepts application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
resolveLoginPendingTaskRequest
resolveLoginPendingTaskRequest {
parameters {
parameters( parameters, required )
taskID( string )
}
parameters {
Action( string, required )
deliveryTargetKey( string )
verificationCode( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
loginResponse
loginResponse {
pendingTasks( Collection of string )
loginState( string )
avatarURL( string )
authToken( string )
lastLoginDate( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
pendingAgreements( Collection of string )
csrfToken( string )
pendingTaskData( anyType )
authTokenValidUntil( string )
sessionValidUntil( string )
status( string )
userFDN( string )
}
POST/appLoginappLogin
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
appID
form
string
secretKey
form
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
any
POST/federatedLoginfederatedLogin
Parameters
Accepts application/json application/vnd.soa.v71+json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
loginRequest
loginRequest {
federationLogins( boolean, required )
fedMemberId( string )
password( string )
authToken( string )
domainName( string )
userName( string )
email( string )
invitationCode( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/initiateSSOLogininitiateSSOLogin
Parameters
Accepts */*
Name
Type
Description
Model
provider
query
string
Reponse
Produces text/plain
Status Code
Reason
Model
200
Success
string
GET/ssoLoginInstructionsssoLoginInstructions
Parameters
Accepts */*
Name
Type
Description
Model
domain
query
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
loginData
loginData {
entry {
authenticationToken {
setCookie {}
loginResponse {
signupCode( string )
redirectUrl( string )
authTokenString( string )
userAttributes( Collection of entry )
authToken( authenticationToken )
cookieHeader( setCookie )
identityAttributesNeeded( Collection of string )
secretAttributesNeeded( Collection of string )
instructionType( string )
userState( string )
response( loginResponse )
state( string )
status( string )
}
entry {
value( string )
key( string )
}
authenticationToken {
claimedIdentifier( string )
identityProviderUrl( string )
tokenID( string )
expirationTime( dateTime )
identityProperties( Collection of entry )
nonce( base64Binary )
}
setCookie {}
loginResponse {
pendingTasks( Collection of string )
loginState( string )
avatarURL( string )
authToken( string )
lastLoginDate( string )
loginDomainID( string )
pendingNotifications( int )
userName( string )
pendingAgreements( Collection of string )
csrfToken( string )
pendingTaskData( anyType )
authTokenValidUntil( string )
sessionValidUntil( string )
status( string )
userFDN( string )
}
GET/loginWithSSOloginWithSSO
Parameters
Accepts */*
Name
Type
Description
Model
provider
query
string
Reponse
Produces application/javascriptapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
string
POST/renewTokenrenewToken
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
federationLogins
form
boolean
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/renewTokenrenewTokenGet
Reponse
Produces application/jsontext/javascriptapplication/javascriptapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
GET/logoutlogoutGet
Reponse
Produces application/jsontext/javascriptapplication/javascriptapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
string
POST/logoutlogout
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
fedmemberId
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
POST/federatedLogoutfederatedLogout
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
fedmemberId
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
POST/authenticateWithPasswordResetCodeauthenticateWithPasswordResetCodeFormPost
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
email
form
string
passwordResetCode
form
string
newPassword
form
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
POST/authenticateWithPasswordResetCodeauthenticateWithPasswordResetCode
Parameters
Accepts application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
PasswordResetRequest
PasswordResetRequest {
UserIdentificationChallenge {
NewPassword( string )
Email( string, required )
UserIdentificationChallenge( UserIdentificationChallenge, required )
PasswordResetCode( string, required )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string, required )
ChallengeQuestion( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
PasswordResetResponse
PasswordResetResponse {
UserIdentificationChallenge {
emailAddress( string )
ResetStatus( string )
UserIdentificationChallenge( UserIdentificationChallenge )
userName( string )
}
UserIdentificationChallenge {
Answer( string )
UserID( string )
ChallengeCode( string )
ChallengeQuestion( string )
}
POST/authenticateWithEmailChangeCodeauthenticateWithEmailChangeCode
Parameters
Accepts application/json application/vnd.soa.v72+json application/vnd.soa.v80+json application/vnd.soa.v81+json
Name
Type
Description
Model
body
entity
emailChangeRequest
emailChangeRequest {
password( string )
changeCode( string )
newEmailAddress( string )
}
Reponse
Produces application/jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
emailChangeResponse
emailChangeResponse {
userIdentificationChallenge {}
userIdentificationChallenge( userIdentificationChallenge )
changeStatus( boolean )
userName( string )
newEmailAddress( string )
}
userIdentificationChallenge {}
GET/domains/{LoginDomainID}getLoginDomain
Parameters
Name
Type
Description
Model
LoginDomainID
path
string
cache
query
boolean
Reponse
Produces application/xmlapplication/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v71+xmlapplication/vnd.soa.v72+xmlapplication/vnd.soa.v80+xmlapplication/vnd.soa.v81+jsonapplication/vnd.soa.v81+xml
Status Code
Reason
Model
200
Success
LoginDomain
LoginDomain {
DisplayMode( string )
FedmemberId( string )
LogoAssigned( boolean )
DomainName( string )
IdSystemType( string )
Title( string )
Enabled( boolean )
LogoId( long )
LoginDomainID( string )
Sequence( int )
VirtualHost( Collection of string )
}
GET/domains/{LoginDomainID}/logogetLoginDomainLogo
Parameters
Name
Type
Description
Model
LoginDomainID
path
string
size
query
integer
cache
query
boolean
Reponse
Produces image/png
Status Code
Reason
Model
200
Success
byte
GET/ssoLogin{domainid:(/[^/]+?)?}ssoLogin
Parameters
Accepts */*
Name
Type
Description
Model
domain
query
string
domainid
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
POST/ssoLogin{domainid:(/[^/]+?)?}ssoLoginPost
Parameters
Accepts application/x-www-form-urlencoded
Name
Type
Description
Model
domainid
path
string
Reponse
Produces application/jsonapplication/vnd.soa.v71+jsonapplication/vnd.soa.v72+jsonapplication/vnd.soa.v80+jsonapplication/vnd.soa.v81+json
Status Code
Reason
Model
200
Success
any
