You are viewing the docs for an old API version (v2) → View v2.01

The SSO object

SSO (Single Sign-On) allows you to access to the Dashboard. You can create multiple SSOs so that several users can access to the Dashboard with personal credentials and specific permissions.

Parameters

Id
string

string:

Maximum length is 255 characters

The item's ID

CreationDate
timestamp

timestamp

When the item was created

Tag
string

string:

Maximum length is 255 characters

Custom data that you can add to this item

FirstName
string

string:

Maximum length is 255 characters

The name of the user.

LastName
string

string:

Maximum length is 255 characters

The last name of the user.

Email
string

string:

Maximum length is 255 characters

The user's email address - must be a valid email (not more than 12 consecutive numbers). This email should not be already used for another SSO. (not more than 12 consecutive numbers)

Active
bool

bool:

true, false

Whether the SSO is active or not

InvitationStatus
InvitationStatus

InvitationStatus:

ACCEPTED, SENT, EXPIRED

Status of the invitation sent to the user to confirm the SSO activation

LastLoginDate
timestamp

timestamp

Date of the latest authentification

PermissionGroupId
string

string:

Maximum length is 255 characters

PermissionGroup assigned to this SSO

ClientId
string

string:

Maximum length is 255 characters

An ID for the client (i.e. url friendly, lowercase etc - sort of namespace identifier)

{
"Id": "8494514",
"CreationDate": 12926321,
"Tag": "custom meta",
"FirstName": "Joe",
"LastName": "Blogs",
"Email": "mangopay@oasis.com",
"Active": true,
"InvitationStatus": "ACCEPTED",
"LastLoginDate": 1463494366,
"PermissionGroupId": "8494514",
"ClientId": "mangopay"
}

Create a SSO

Note that the email supplied when creating a SSO must be unique - it cannot already be used for another SSO. After the SSO is created, the email will not be modifiable.

POST .../v2/ClientId

The ID of your client account

/clients/SSOs

Parameters

Tag
string

string:

Maximum length is 255 characters
optional

Custom data that you can add to this item

FirstName
string

string:

Maximum length is 255 characters
required

The name of the user.

LastName
string

string:

Maximum length is 255 characters
required

The last name of the user.

Email
string

string:

Maximum length is 255 characters
required

The user's email address - must be a valid email (not more than 12 consecutive numbers). This email should not be already used for another SSO. (not more than 12 consecutive numbers)

PermissionGroupId
string

string:

Maximum length is 255 characters
required

PermissionGroup assigned to this SSO

  • View
  • Code
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
POST .../clients/SSOs HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"FirstName": "Joe",
"LastName": "Blogs",
"Email": "mangopay@oasis.com",
"PermissionGroupId": "8494514"
}
POST .../clients/SSOs HTTP/1.1
Body Parameters :
{
"Tag": "",
"FirstName": "",
"LastName": "",
"Email": "",
"PermissionGroupId": ""
}

Update a SSO

PUT .../v2/ClientId

The ID of your client account

/clients/ssos/SSOId/

Parameters

Tag
string

string:

Maximum length is 255 characters
optional

Custom data that you can add to this item

FirstName
string

string:

Maximum length is 255 characters
optional

The name of the user.

LastName
string

string:

Maximum length is 255 characters
optional

The last name of the user.

PermissionGroupId
string

string:

Maximum length is 255 characters
optional

PermissionGroup assigned to this SSO

Active
bool

bool:

true, false
optional

Whether the SSO is active or not

  • View
  • Code
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
PUT .../clients/ssos/:SSOId/ HTTP/1.1
Body Parameters :
{
"Tag": "custom meta",
"FirstName": "Joe",
"LastName": "Blogs",
"PermissionGroupId": "8494514",
"Active": true
}
PUT .../clients/ssos// HTTP/1.1
Body Parameters :
{
"Tag": "",
"FirstName": "",
"LastName": "",
"PermissionGroupId": "",
"Active": ""
}

View a SSO

GET .../v2/ClientId

The ID of your client account

/clients/ssos/SSOId/
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../clients/ssos/:SSOId/ HTTP/1.1
GET .../clients/ssos// HTTP/1.1

List all SSO accesses

GET .../v2/ClientId

The ID of your client account

/clients/ssos

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

  • View
  • Code
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../clients/ssos HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC"
}
GET .../clients/ssos HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": ""
}

Extend SSO invitation

PUT .../v2/ClientId

The ID of your client account

/clients/ssos/SSOId/extendinvitation
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
PUT .../clients/ssos/:SSOId/extendinvitation HTTP/1.1
PUT .../clients/ssos//extendinvitation HTTP/1.1

List SSOs for a permission group

GET .../v2/ClientId

The ID of your client account

/clients/PermissionGroups/PermissionGroupId

Id of a permission group

/SSOs

Get parameters

Page
int

int
optional

The page number of results you wish to return

Per_Page
int

int
optional

The number of results to return per page

Sort
ColumnAndDirection

ColumnAndDirection:

CreationDate:ASC / CreationDate:DESC
optional

The column to sort against and direction - only CreationDate (or Date for the events) is available and ASC or DESC for the direction

  • View
  • Code
    Code samples are only available for the latest API version
  • Run
  • View
  • Code
    Code samples are only available for the latest API version
  • Run
GET .../clients/PermissionGroups/:PermissionGroupId/SSOs HTTP/1.1
Get Parameters :
{
"Page": 1,
"Per_Page": 25,
"Sort": "CreationDate:DESC"
}
GET .../clients/PermissionGroups//SSOs HTTP/1.1
Get Parameters :
{
"Page": ,
"Per_Page": ,
"Sort": ""
}
Share feedback