PATCH
/
idps
/
{IDENTITY_PROVIDER_ID}
curl --request PATCH \
  --url https://api.vidbeo.com/v2/idps/{IDENTITY_PROVIDER_ID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example",
  "company": "google",
  "type": "saml2",
  "certificate": "----- BEGIN PUBLIC KEY -----\\nMIIII...",
  "entity_id": "https://example.com/signin",
  "signin_url": "https://example.com/signin"
}'
{
  "success": true,
  "result": {
    "id": "abcde12345abcde12345a",
    "name": "Example",
    "company": "google",
    "type": "saml2",
    "certificate": "----- BEGIN PUBLIC KEY -----\nMIIII...",
    "entity_id": "https://example.com/signin",
    "signin_url": "https://example.com/signin",
    "created_by": "abcde12345abcde12345a",
    "created_time": "2024-01-01T00:00:00.000Z",
    "updated_by": "abcde12345abcde12345a",
    "updated_time": "2024-01-01T00:00:00.000Z"
  },
  "links": {},
  "errors": []
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
IDENTITY_PROVIDER_ID
string
required

ID of the identity provider

Example:

"abcde12345abcde12345a"

Body

application/json
​
name
string
Required string length: 1 - 40
Example:

"Example"

​
company
enum<string>
Available options:
google,
okta
Example:

"google"

​
type
enum<string>
Available options:
saml2
Example:

"saml2"

​
certificate
string

The public certificate the IDP will provide

Example:

"----- BEGIN PUBLIC KEY -----\\nMIIII..."

​
entity_id
string

The entity ID your application uses

Example:

"https://example.com/signin"

​
signin_url
string

The URL the IDP expects SAML2 requests to be POSTed to

Example:

"https://example.com/signin"

Response

200
application/json
Identity provider
​
success
boolean
required
Example:

true

​
result
object
required
​
links
object
required
Example:
{}
​
errors
object[]
required
Example:
[]