This endpoint returns information about SAML configurations, including which, if any, is the default SAML configuration, whether global or domain (URL)-based.

Common Error Codes

  • 404 No Content - Package not found; returns an error object
  • 400 Bad Request - Request parameters are invalid; returns an error object
  • 500 Internal Server Error - Request is valid but the server encountered an error; returns an error object

Get current SAML configurations

GET /api/saml_configurations

This method returns a list of all SAML configurations. All user profiles associated with the SAML configuration are displayed, including specific attributes ((saml_configuration_id and saml_field_name) and global attributes (all other attributes).

Request Body: None

Query Parameters: None

Success Response Code

  • HTTP 200 OK - Returned with an array of SAML configurations, each containing an array of user profile fields

Response Attributes - SAML Configurations

Parameter Name Type Description
id string Read-only value
created_at Date and time format Date and time SAML configuration created
updated_at Date and time format Date and time SAML configuration updated
name string Name of SAML configuration
public_description string Viewable description o SAML configuration
default boolean This is the default SAML configuration
sso_target_url string The URL to the SAML IDP login page
domain_url string URL for the specific domain of the default SAML configuration

Response Attributes - User Profile Fields

id string Read-only value
created_at Date and time format Date and time SAML configuration created
updated_at Date and time format Date and time SAML configuration updated
enabled boolean If this is set to true, only the name of the SAML configuration can be changed.
required boolean If this is set to true and the name of the SAML configuration is missing, the request will fail with an error.
saml_configuration_id string ID for the SAMl configuration
saml_field_name string Name of the SAML field

Success Response Example

[
{
"id":1,
"created_at":"2016/07/06 15:38:41 -0700",
"updated_at":"2016/07/06 15:38:42 -0700",
"name":"Enterprise",
"public_description":"Log in with Enterprise",
"default":false,
"sso_target_url":"https://shib-idp-01.dev.aspera.us/idp/profile/SAML2/Redirect/SSO",
"domain_url":"",
"user_profile_fields":[
{
"id":29,
"name":"Department",
"enabled":true,
"required":false,
"created_at":"2016/07/06 15:07:58 -0700",
"updated_at":"2016/07/06 15:07:58 -0700",
"saml_configuration_id":1,
"saml_field_name":"department_name"
},
{
"id":30,
"name":"Company",
"enabled":true,
"required":true,
"created_at":"2016/07/06 15:07:58 -0700",
"updated_at":"2016/07/06 15:07:58 -0700",
"saml_configuration_id":1,
"saml_field_name":"company_name"
}
]
}
]


Get a SAML configuration

GET /api/saml_configurations/{id}

This method returns information about a particular SAML configuration by ID.

Query Parameters: None

Request Body: None

Success Response Code

  • 200 OK - Returned with SAML configuration information

Response Example

{
"id":29,
"name":"Department",
"enabled":true,
"required":false,
"created_at":"2016/07/06 15:07:58 -0700",
"updated_at":"2016/07/06 15:07:58 -0700",
"saml_configuration_id":1,
"saml_field_name":"department_name"
}
Video player

Video

×