This endpoint allows you to see information about user profile fields, both for normal users and for SAML configuration

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 profile fields

GET /api/user_profile_fields

This method returns a complete list of user profile fields.

Request Body: None

Query Parameters

Parameter Name Type Description
saml_configuration_id string The ID for the SAML configuration (optional)

Success Response Code

  • 200 OK - Returned with an array of user profile fields

Success Response

Non-SAML query:
[
{
"id":1,
"name":"Company",
"enabled":true,
"required":true,
"created_at":"2016/06/22 12:28:07 -0700",
"updated_at":"2016/06/22 12:28:07 -0700"
}
]
 
SAML query:
 
[
{
"id":2,
"name":"Company",
"enabled":true,
"required":true,
"created_at":"2016/07/05 15:48:19 -0700",
"updated_at":"2016/07/05 15:48:19 -0700",
"saml_configuration_id":1,
"saml_field_name":"company_name"
}
]

Get a profile field

GET /api/user_profile_fields/:id

This method returns information about a particular user profile by its ID.

Query Parameters

Parameter Name Type Description
saml_configuration_id string The ID for the SAML configuration (optional)

Request Body: none

Response Codes

  • 200 OK - Returned with user profile field information

Response Example

[
{
"id":2,
"name":"Company",
"enabled":true,
"required":true,
"created_at":"2016/07/05 15:48:19 -0700",
"updated_at":"2016/07/05 15:48:19 -0700",
"saml_configuration_id":1,
"saml_field_name":"company_name"
}
]
Video player

Video

×