Skip to main content
GET
/
api
/
profiles
List all profiles
curl --request GET \
  --url http://localhost:3010/api/profiles \
  --header 'Authorization: <api-key>'
{
  "Status": "ok",
  "ID": "github-sso-dashboard",
  "Data": [
    {
      "ID": "github-sso-dashboard",
      "Name": "GitHub SSO - Dashboard Login",
      "OrgID": "5e9d9544a1dcd60001d0ed20",
      "MatchedPolicyID": "5f8f9e3c1b5e4a0001b3c4d5",
      "CustomEmailField": "email",
      "CustomUserIDField": "sub",
      "ProviderConfig": {},
      "IdentityHandlerConfig": {
        "oauth-client-id": "tyk-portal-client",
        "oauth-client-secret": "s3cr3t",
        "oauth-client-base-url": "http://gateway:8080"
      },
      "ProviderConstraints": {
        "Domain": "tyk.io",
        "Group": "engineering"
      },
      "ReturnURL": "https://dashboard.example.com/tap",
      "DefaultUserGroupID": "5f8f9e3c1b5e4a0001b3c4d6",
      "CustomUserGroupField": "groups",
      "UserGroupMapping": {
        "admins": "5f8f9e3c1b5e4a0001b3c4d7",
        "developers": "5f8f9e3c1b5e4a0001b3c4d8"
      },
      "UserGroupSeparator": ",",
      "SSOOnlyForRegisteredUsers": false
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Must equal the Secret value in tib.conf. Example: Authorization: your-tib-secret

Response

Array of profiles (may be empty).

​
Status
enum<string>
Available options:
ok
Example:

"ok"

​
ID
string

The profile ID the operation was performed on.

Example:

"github-sso-dashboard"

​
Data
object[]

Payload — a single Profile object, a list of Profiles, or an empty object.