STS

STS

Users authentication service.

Free subscription

Technical Overview

STS Service

Allows to get an authentication Token for SAPO users (via emails and password). This Token can be used to access services and/or operations that require a specific authorization level.

API Reference

Service Operation Description
STS GetPrimaryId Returns user information, his primary id and a security token.
GetPrimaryIdDetails Returns user information, his primary id,a security token and additional attributes
GetToken Returns a token if the specified username and password are valid

STS Service

Operations

GetPrimaryId

Returns user information, his primary id and a security token.
Request Parameters
ESBCredentials : ESBCredentials (optional)
UserLogin : string (optional)
JSON : boolean (optional)
UserType : string (optional)
UserLoginCredentialsStore : string (optional)
Response Parameters
GetPrimaryIdResult : UserInfo (optional)
Go to top

GetPrimaryIdDetails

Returns user information, his primary id,a security token and additional attributes
Request Parameters
ESBCredentials : ESBCredentials (optional)
UserLogin : string (optional)
JSON : boolean (optional)
UserType : string (optional)
UserLoginCredentialsStore : string (optional)
Response Parameters
GetPrimaryIdDetailsResult : UserInfo (optional)
Go to top

GetToken

Returns a token if the specified username and password are valid
Request Parameters
ESBCredentials : ESBCredentials (optional)
JSON : boolean (optional)
Response Parameters
GetTokenResult : string (optional)
Go to top

STS Entities

AccountNumbers

Attribute Name Description
List of AccountNumber : string
Go to top

ArrayOfAttribute

Attribute Name Description
List of Attribute : Attribute (optional)
Go to top

Attribute

Attribute Name Description
Name : string
Value : string
Go to top

ESBCredentials

Go to top

ESBRoles

Go to top

UserInfo

Aggregator type that contains information about the authentication response: primary identifier, token additional information and user
Attribute Name Description
PrimaryId : string Primary identifier
ESBRoles : ESBRoles (optional)
ESBToken : string
Group : string (optional)
ESBCredentialsStore : string (optional)
AccountNumbers : AccountNumbers (optional)
Attributes : ArrayOfAttribute (optional)
Go to top

SOAP API Authentication

Authenticating SOAP Request

Every request must contain authentication information to establish the identity of whom making the request and a autorization token called ESB Access Key.

ESB Access Key

Correct with the path to the access key

The ESB Access Key is what will authorize the usage of the API and is available when the buying process ends. In the costumer area you can find the product details where you can generate an ESB Access Key for you usage, another user registered on SAPO Services or even for everyone.

The element ESBAccessKey must appear on the message SOAP Header after the complex type ESBCredentials

Example:

ESBCredentials

ESBCredentials is a complex type that is used to pass the credentials in order to authenticate a SOAP request.

Request with username and password
Elements Description
ESBUsername The e-mail of the account that is used to access the API
ESBPassword The password that in combination with the ESBUsername is used to access the corresponding account

Example:

Request with ESBToken

Using a token instead of your username and password can be useful if you don't want to give your credentials to whom is using the API.

In order to generate a ESB Token you must use SAPO Security Token Service (STS). The ESBtoken is valid for 12 hours.

Requesting with an ESBtoken
Go to top