Skip to content
Authrim

Create an external identity provider.

POST
/api/admin/external-providers
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/external-providers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "provider_key": "google", "display_name": "Google", "issuer": "https://accounts.google.com" }'

Forwards the request body to the configured External IdP Bridge provider creation endpoint. If the bridge is not configured, returns a service-unavailable error. profile_update_fields chooses the profile fields a login from this provider updates (with external_idp.jit_update_on_login on): null follows the tenant’s external_idp.jit_update_fields, [] updates none, and a list names any of name, given_name, family_name, middle_name, nickname, profile, picture, website, gender, birthdate, zoneinfo and locale, each once; any other value is refused with 400.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json

Body forwarded to the configured External IdP Bridge admin endpoint.

object
key
additional properties
Example 
{
  "provider_key": "google",
  "display_name": "Google",
  "issuer": "https://accounts.google.com"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Response proxied from the External IdP Bridge.

Media type application/json

JSON body returned by the configured External IdP Bridge admin endpoint.

object
key
additional properties
Example generated
{
  "additionalProperty": "example"
}

201

Section titled “201 ”

Response proxied from the External IdP Bridge.

Media type application/json

JSON body returned by the configured External IdP Bridge admin endpoint.

object
key
additional properties
Example generated
{
  "additionalProperty": "example"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Section titled “500 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Section titled “503 ”

Error response.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}