Authcore API (2.0)

Download OpenAPI specification:Download

ui

UI preferences

query Parameters
client_id
string

Application ID

Responses

200

Success

get /api/v2/ui_preferences
/api/v2/ui_preferences

Response samples

Content type
application/json
Copy
Expand all Collapse all
{ }

audit_logs

List Audit Logs

query Parameters
user_id
required
string

User ID

limit
string

Pagination Object limit

page_token
string

Pagination Token

Responses

200

Success

get /api/v2/audit_logs
/api/v2/audit_logs

Response samples

Content type
application/json
Copy
Expand all Collapse all
{ }

authn

Start an local authentication transaction

Request Body schema: application/json
client_id
required
string
handle
required
string
code_challenge_method
string
code_challenge
string
redirect_uri
required
string <uri>

Responses

200

Success

post /api/v2/authn
/api/v2/authn

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "client_id": "string",
  • "handle": "string",
  • "code_challenge_method": "string",
  • "code_challenge": "string",
  • "redirect_uri": "http://example.com"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "status": "string",
  • "password_method": "string",
  • "password_salt": "string",
  • "factors":
    [
    ],
  • "idp_authorization_url": "http://example.com",
  • "authorization_code": "string"
}

Request a password key exchange challenge

Request Body schema: application/json
state_token
string
message
string

Responses

200

Success

post /api/v2/authn/password
/api/v2/authn/password

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "message": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "challenge": "string"
}

Verify password factor

Request Body schema: application/json
state_token
required
string
verifier
required
string

Responses

200

Success

post /api/v2/authn/password/verify
/api/v2/authn/password/verify

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "verifier": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "status": "string",
  • "password_method": "string",
  • "password_salt": "string",
  • "factors":
    [
    ],
  • "idp_authorization_url": "http://example.com",
  • "authorization_code": "string"
}

Request a MFA challenge

path Parameters
method
required
string
Request Body schema: application/json
state_token
string
message
string

Responses

200

Success

post /api/v2/authn/mfa/{method}
/api/v2/authn/mfa/{method}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "message": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "challenge": "string"
}

Verify a MFA factor

path Parameters
method
required
string
Request Body schema: application/json
state_token
required
string
verifier
required
string

Responses

200

Success

post /api/v2/authn/mfa/{method}/verify
/api/v2/authn/mfa/{method}/verify

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "verifier": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "status": "string",
  • "password_method": "string",
  • "password_salt": "string",
  • "factors":
    [
    ],
  • "idp_authorization_url": "http://example.com",
  • "authorization_code": "string"
}

Start a third-party IDP authentication transaction

Request Body schema: application/json
client_id
required
string
code_challenge
string
code_challenge_method
string
redirect_uri
required
string <uri>

Responses

200

Success

post /api/v2/authn/idp/{provider}
/api/v2/authn/idp/{provider}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "client_id": "string",
  • "code_challenge": "string",
  • "code_challenge_method": "string",
  • "redirect_uri": "http://example.com"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "status": "string",
  • "password_method": "string",
  • "password_salt": "string",
  • "factors":
    [
    ],
  • "idp_authorization_url": "http://example.com",
  • "authorization_code": "string"
}

Verify a third-party IDP authorization grant

Request Body schema: application/json
state_token
required
string
code
required
string

Responses

200

Success

post /api/v2/authn/idp/{provider}/verify
/api/v2/authn/idp/{provider}/verify

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "code": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "status": "string",
  • "password_method": "string",
  • "password_salt": "string",
  • "factors":
    [
    ],
  • "idp_authorization_url": "http://example.com",
  • "authorization_code": "string"
}

Start a third-party IDP binding transaction

Request Body schema: application/json

Responses

200

Success

post /api/v2/authn/idp_binding/{provider}
/api/v2/authn/idp_binding/{provider}

Request samples

Content type
application/json
Copy
Expand all Collapse all
{ }

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "status": "string",
  • "password_method": "string",
  • "password_salt": "string",
  • "factors":
    [
    ],
  • "idp_authorization_url": "http://example.com",
  • "authorization_code": "string"
}

Verify a third-party IDP authorization grant for a third-party IDP binding transaction.

Request Body schema: application/json
state_token
required
string
code
required
string

Responses

200

Success

post /api/v2/authn/idp_binding/{provider}/verify
/api/v2/authn/idp_binding/{provider}/verify

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "code": "string"
}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state_token": "string",
  • "status": "string",
  • "password_method": "string",
  • "password_salt": "string",
  • "factors":
    [
    ],
  • "idp_authorization_url": "http://example.com",
  • "authorization_code": "string"
}

idp

Get IDP

Responses

200

Success

get /api/v2/idp/{id}
/api/v2/idp/{id}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "id": 0,
  • "user_id": 0,
  • "service": 0,
  • "oauth_user_id": "string",
  • "updated_at": "2020-07-28T07:02:19Z",
  • "created_at": "2020-07-28T07:02:19Z",
  • "last_used_at": "2020-07-28T07:02:19Z",
  • "metadata": { }
}

mfa

Delete MFA

Responses

204

Success

delete /api/v2/mfa/{id}
/api/v2/mfa/{id}

signup

Create a new user using primary authentication method.

Request Body schema: application/json
client_id
required
string
password_verifier
required
SPAKE2PlusVerifier (object) (PasswordVerifier)
redirect_uri
required
string <uri>
email
string
phone
string
name
string

Responses

200

Success

post /api/v2/signup
/api/v2/signup

Request samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "client_id": "string",
  • "password_verifier":
    {