Identity Providers

List all identity providers

get

Authorizations

Query parameters

pageintegerOptional

The page number of results

Example: 1

limitintegerOptional

The number of results to return per page

Example: 10

Responses

200

A list of configured identity providers

application/json

totalinteger · int32OptionalExample: 25

nextPagenumber · int32 · nullableOptionalExample: 2

400

Bad Request

application/json

401

Unauthorized

application/json

get/v2/identity-providers

GET /v2/identity-providers HTTP/1.1
Host: api.appetize.io
Accept: */*

{
  "total": 25,
  "nextPage": 2,
  "providers": [
    {
      "id": "idp_abc123",
      "key": "bsad123",
      "type": "saml",
      "config": {
        "entryPoint": "https://sso.example.com/saml/login",
        "issuer": "https://sso.example.com/saml",
        "cert": "-----BEGIN CERTIFICATE-----MIID...-----END CERTIFICATE-----",
        "certExpires": "2030-01-01T00:00:00.000Z",
        "cbUrl": "/sso/idp-key/auth/cb"
      },
      "created": "2020-01-01T00:00:00.000Z",
      "createdBy": "user@appetize.io",
      "updated": "2020-01-01T00:00:00.000Z",
      "updatedBy": "user@appetize.io"
    }
  ]
}

Create a new identity provider

post

Authorizations

Body

typestring · enumRequiredPossible values:

configone ofRequired

Responses

201

Created successfully

application/json

idstringRequired

The unique identifier for the Identity Provider

Example: idp_abc123

keystringRequired

URL-safe, human-readable identifier

Example: bsad123

typestring · enumRequiredExample: samlPossible values:

configone ofRequired

createdstring · date-timeRequired

Timestamp when the provider was created

Example: 2020-01-01T00:00:00.000Z

createdBystringRequired

Username or token label that created the provider

Example: user@appetize.io

updatedstring · date-timeOptional

Timestamp of the last update

Example: 2020-01-01T00:00:00.000Z

updatedBystringOptional

Username or token label that last modified the provider

Example: user@appetize.io

400

Bad Request

application/json

401

Unauthorized

application/json

post/v2/identity-providers

POST /v2/identity-providers HTTP/1.1
Host: api.appetize.io
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "type": "saml",
  "config": {
    "entryPoint": "https://sso.example.com/saml/login",
    "issuer": "https://sso.example.com/saml",
    "cert": "-----BEGIN CERTIFICATE-----MIID...-----END CERTIFICATE-----"
  }
}

{
  "id": "idp_abc123",
  "key": "bsad123",
  "type": "saml",
  "config": {
    "entryPoint": "https://sso.example.com/saml/login",
    "issuer": "https://sso.example.com/saml",
    "cert": "-----BEGIN CERTIFICATE-----MIID...-----END CERTIFICATE-----",
    "certExpires": "2030-01-01T00:00:00.000Z",
    "cbUrl": "/sso/idp-key/auth/cb"
  },
  "created": "2020-01-01T00:00:00.000Z",
  "createdBy": "user@appetize.io",
  "updated": "2020-01-01T00:00:00.000Z",
  "updatedBy": "user@appetize.io"
}

Get an identity provider by ID

get

Authorizations

Path parameters

idpIdstringRequiredExample: idp_abc123

Responses

200

Identity provider config

application/json

idstringRequired

The unique identifier for the Identity Provider

Example: idp_abc123

keystringRequired

URL-safe, human-readable identifier

Example: bsad123

typestring · enumRequiredExample: samlPossible values:

configone ofRequired

createdstring · date-timeRequired

Timestamp when the provider was created

Example: 2020-01-01T00:00:00.000Z

createdBystringRequired

Username or token label that created the provider

Example: user@appetize.io

updatedstring · date-timeOptional

Timestamp of the last update

Example: 2020-01-01T00:00:00.000Z

updatedBystringOptional

Username or token label that last modified the provider

Example: user@appetize.io

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

get/v2/identity-providers/{idpId}

GET /v2/identity-providers/{idpId} HTTP/1.1
Host: api.appetize.io
Accept: */*

{
  "id": "idp_abc123",
  "key": "bsad123",
  "type": "saml",
  "config": {
    "entryPoint": "https://sso.example.com/saml/login",
    "issuer": "https://sso.example.com/saml",
    "cert": "-----BEGIN CERTIFICATE-----MIID...-----END CERTIFICATE-----",
    "certExpires": "2030-01-01T00:00:00.000Z",
    "cbUrl": "/sso/idp-key/auth/cb"
  },
  "created": "2020-01-01T00:00:00.000Z",
  "createdBy": "user@appetize.io",
  "updated": "2020-01-01T00:00:00.000Z",
  "updatedBy": "user@appetize.io"
}

Delete an identity provider by ID

delete

Authorizations

Path parameters

idpIdstringRequiredExample: idp_abc123

Responses

204

Deleted successfully

No content

400

Bad Request

application/json

delete/v2/identity-providers/{idpId}

DELETE /v2/identity-providers/{idpId} HTTP/1.1
Host: api.appetize.io
Accept: */*

No content

Update an existing identity provider

patch

Authorizations

Path parameters

idpIdstringRequiredExample: idp_abc123

Body

configone ofRequired

Responses

200

Updated provider

application/json

idstringRequired

The unique identifier for the Identity Provider

Example: idp_abc123

keystringRequired

URL-safe, human-readable identifier

Example: bsad123

typestring · enumRequiredExample: samlPossible values:

configone ofRequired

createdstring · date-timeRequired

Timestamp when the provider was created

Example: 2020-01-01T00:00:00.000Z

createdBystringRequired

Username or token label that created the provider

Example: user@appetize.io

updatedstring · date-timeOptional

Timestamp of the last update

Example: 2020-01-01T00:00:00.000Z

updatedBystringOptional

Username or token label that last modified the provider

Example: user@appetize.io

400

Bad Request

application/json

401

Unauthorized

application/json

404

Not Found

application/json

patch/v2/identity-providers/{idpId}

PATCH /v2/identity-providers/{idpId} HTTP/1.1
Host: api.appetize.io
Content-Type: application/json
Accept: */*
Content-Length: 171

{
  "config": {
    "entryPoint": "https://sso.example.com/saml/login",
    "issuer": "https://sso.example.com/saml",
    "cert": "-----BEGIN CERTIFICATE-----MIID...-----END CERTIFICATE-----"
  }
}

{
  "id": "idp_abc123",
  "key": "bsad123",
  "type": "saml",
  "config": {
    "entryPoint": "https://sso.example.com/saml/login",
    "issuer": "https://sso.example.com/saml",
    "cert": "-----BEGIN CERTIFICATE-----MIID...-----END CERTIFICATE-----",
    "certExpires": "2030-01-01T00:00:00.000Z",
    "cbUrl": "/sso/idp-key/auth/cb"
  },
  "created": "2020-01-01T00:00:00.000Z",
  "createdBy": "user@appetize.io",
  "updated": "2020-01-01T00:00:00.000Z",
  "updatedBy": "user@appetize.io"
}

PreviousBuilds

NextReports

Last updated 10 days ago