Update Issuer

Operation ID: issuers.update
PATCH
https://api.authpi.com/v1/accounts/{account_id}/issuers/{issuer_id}

Update an issuer by its ID.

Request

Request body

Schema | application/json
name

A name for the resource.

string
description

Content in specified format.

required object
content_type
One of: plainmarkdownhtml
required string
value

The content value.

required string
public_description

Content in specified format.

required object
content_type
One of: plainmarkdownhtml
required string
value

The content value.

required string
display_name

The name of the issuer that will be displayed to the user

string
links
object
privacy_policy
string[uri]
terms_of_service
string[uri]
website
string[uri]
support
string[uri]
documentation
string
settings
required object
allow_new_users
required boolean
allow_new_orgs
required boolean
create_new_org_on_signup
required boolean
verify_email_address_on_signup
required boolean
allowed_hosts
array[string]
authentication
required object
methodes
required array[object]
id
required string[uuid]
name

A name for the resource.

required string
method
One of: oauth2passwordtemporary-passwordemail-linkwebauthntotp_appbackup_codes
required string
first_factor_only
required boolean
enabled
required boolean
settings
required
created_at

Unix timestamp in milliseconds

required integer
updated_at

Unix timestamp in milliseconds

required integer
methods_featured

What methods should be featured in the issuer's login and signup pages

array[string]
signup
object
portals
object
enable_signup
required boolean
signup_page_url

Alternative URL to the signup page

string[uri]
enable_login
required boolean
login_page_url

Alternative URL to the login page

string[uri]
enable_password_reset
required boolean
password_reset_page_url

Alternative URL to the password reset page

string[uri]
enable_profile
required boolean
profile_page_url

Alternative URL to the profile page

string[uri]
logo
object
image

A base64 encoded image

string
mime_type

The mime type of the image

string
image_dark

A base64 encoded image

string
mime_type_dark

The mime type of the image

string
image_url

An URL from where to fetch the image

string[uri]
image_url_dark

An URL from where to fetch the image

string[uri]
link_url

An URL to link to when the logo is clicked

string[uri]
favicon
object
image

A base64 encoded image

string
mime_type

The mime type of the image

string
metadata
object

Responses

200

Issuer

400

Bad request - The request is not valid or missing required parameters.

401

Unauthorized - The request is not allowed because the client or user is not authenticated.

403

Forbidden - The request is not allowed because the client or user does not have the necessary permissions.

404

Not found - The requested resource does not exist.

422

Unprocessable entity - The data provided in the request is not valid.

429

Too many requests - The client has sent too many requests in a given amount of time.

500

Internal server error - An unexpected error occurred while processing the request.