Call the Casdoor API

This guide explains how to authenticate to the Casdoor REST API and call it from your own applications, services, and scripts.

Learning outcomes

Choose the authentication method that fits your caller.
Send an access token, client credentials, or an access key with a request.
Get an access token for a service without a user.
Sign a user out of all sessions through the API.
Allow your frontend origin to call the API from a browser.

What you need

A running Casdoor instance. The examples use the demo site https://door.casdoor.com.
An application in Casdoor, with its client ID and client secret

About the Casdoor API

The Casdoor admin console is a React single-page application that calls a REST API. Your code can call the same API, so everything that the console does is available over HTTP. The API has three kinds of callers:

The Casdoor frontend
The Casdoor SDKs, such as casdoor-go-sdk
Your own applications and scripts

The API reference is the Swagger page of your Casdoor instance, for example https://door.casdoor.com/swagger. To regenerate the Swagger files, see Generate Swagger files.

Choose an authentication method

Method	The request runs as	Use it for
Access token	The user who signed in, or the application for a client credentials token	Applications that act for a signed-in user, and services that hold a token
Client ID and client secret	The application, with the rights of an administrator of its organization	Machine-to-machine (M2M) calls from backend services, CLIs, and scheduled jobs
Access key and access secret	The organization, application, or user that the key belongs to	Scripts and integrations that need a long-lived credential
Username and password	The user	Local demos and compatibility only

Authenticate with an access token

An access token is what your application receives when a user signs in through OAuth 2.0. A request that carries the token runs with the permissions of that user.

Get the token

Your application receives the token at the end of the OAuth 2.0 authorization code flow, when it exchanges the code for tokens. See OAuth 2.0. An administrator can also see the issued tokens on the Tokens page of the admin console, for example https://door.casdoor.com/tokens.

The following Go handler uses casdoor-go-sdk to exchange the code and read the token:

func (c *ApiController) Signin() {
    code := c.Input().Get("code")
    state := c.Input().Get("state")

    token, err := casdoorsdk.GetOAuthToken(code, state)
    if err != nil {
        c.ResponseError(err.Error())
        return
    }

    claims, err := casdoorsdk.ParseJwtToken(token.AccessToken)
    if err != nil {
        c.ResponseError(err.Error())
        return
    }

    claims.AccessToken = token.AccessToken
    c.SetSessionClaims(claims)

    c.ResponseOk(claims)
}

Send the token

Send the token in the Authorization header:

curl https://door.casdoor.com/api/get-account \
  -H "Authorization: Bearer <access-token>"

Alternatively, send it as the access_token query parameter:

https://door.casdoor.com/api/get-global-providers?access_token=<access-token>

Prefer the header. A token in a URL can end up in server logs and browser history.

Authenticate with a client ID and client secret

Use the credentials of an application for M2M calls, where no user is present. The request runs as the application, with the rights of an administrator of the application's organization. Typical callers are:

Backend services that manage users or permissions in Casdoor
CLI tools, scheduled jobs, and synchronization scripts
Business-to-business (B2B) setups, where each customer organization has its own application and manages its own users with that application's credentials

Get the credentials

In the Casdoor admin console, open the edit page of the application, for example https://door.casdoor.com/applications/casbin/app-vue-python-example.
Copy the Client ID and the Client secret.

Send the credentials with each request

Send the credentials with HTTP Basic authentication. The value is the Base64 encoding of <client-id>:<client-secret>:

curl https://door.casdoor.com/api/get-users?owner=<organization> \
  -u "<client-id>:<client-secret>"

Alternatively, send them as query parameters:

https://door.casdoor.com/api/get-users?owner=<organization>&clientId=<client-id>&clientSecret=<client-secret>

Exchange the credentials for an access token

To avoid sending the client secret with every request, exchange the credentials for an access token with the OAuth 2.0 client credentials grant.

Send a POST request to https://<casdoor-host>/api/login/oauth/access_token:

{
    "grant_type": "client_credentials",
    "client_id": "<client-id>",
    "client_secret": "<client-secret>"
}

Read the access token from the response:

{
    "access_token": "eyJhb...",
    "token_type": "Bearer",
    "expires_in": 10080,
    "scope": "openid"
}

Call the API with the token as described in Send the token.

For the details of the grant, see Client credentials grant.

mẹo

In a B2B product, create one Casdoor application per customer organization. Each customer gets its own client ID and client secret, manages its own users and permissions, and can't reach the data of other organizations.

Authenticate with an access key and access secret

An access key pair is a long-lived credential that you create on the Keys page. A key belongs to an organization, an application, or a user, and a request that carries it runs with the permissions of that owner.

Create a key

In the Casdoor admin console, open the Keys page.
Add a key and select its Type: Organization, Application, or User.
Save the key and copy the access secret. Casdoor doesn't show the secret again.

Send the key

Send the pair as query parameters:

curl "https://door.casdoor.com/api/get-global-providers?accessKey=<access-key>&accessSecret=<access-secret>"

Authenticate with a username and password

cẩn thận

Don't use this method in production. The password travels in the URL, where proxies and servers can log it. Use an access token, client credentials, or an access key instead.

Send the user ID, in the form <organization>/<username>, and the password as query parameters. The request runs as that user.

https://door.casdoor.com/api/get-account?username=<organization>/<username>&password=<password>

Casdoor rejects this method for users who have multi-factor authentication (MFA) enabled.

Set the response language

Casdoor localizes error messages and other text in responses. Send the Accept-Language header to choose the language:

curl https://door.casdoor.com/api/get-account \
  -H "Authorization: Bearer <access-token>" \
  -H "Accept-Language: fr"

Supported codes include en, zh, es, fr, de, ja, and ko. For the full list, see Internationalization.

Sign a user out of all sessions

The /api/sso-logout endpoint signs the authenticated user out of every application, or only out of the current session.

GET or POST /api/sso-logout?logoutAll=<true|false>

Parameter	Required	Description
`logoutAll`	No	`true`, `1`, or omitted: sign out of all sessions. Any other value, such as `false`: sign out of the current session only

	`logoutAll=true` (default)	`logoutAll=false`
Sessions	Deletes all sessions of the user across all applications	Deletes the current session only
Access tokens	Expires all tokens issued to the user	Keeps all tokens
Sign-out notification	Contains all session IDs and token hashes	Contains the current session ID only

Use logoutAll=false when a user signs out on one device and stays signed in on the others.

The request must be authenticated with one of the methods on this page or with the session cookie:

# Sign out of all sessions
curl -X POST https://door.casdoor.com/api/sso-logout \
  -H "Authorization: Bearer <access-token>"

# Sign out of the current session only
curl -X POST "https://door.casdoor.com/api/sso-logout?logoutAll=false" \
  -H "Authorization: Bearer <access-token>"

# Authenticate with the session cookie
curl -X POST https://door.casdoor.com/api/sso-logout \
  --cookie "casdoor_session_id=<session-id>"

A successful request returns:

{
  "status": "ok",
  "msg": "",
  "data": ""
}

Call the API from a browser

Browsers apply cross-origin resource sharing (CORS) rules to calls from your frontend to Casdoor. Casdoor compares the Origin header of a request with the origins that it trusts and, on a match, adds the Access-Control-Allow-* headers. It trusts:

The origins of the Redirect URLs of your applications
The host name of the Casdoor server itself
The value of origin in app.conf
Any origin for the /api/login/oauth/access_token and /api/userinfo endpoints, and the origin appleid.apple.com

The allowed methods are GET, POST, OPTIONS, and DELETE.

To allow your frontend to call the API, add its URL to the Redirect URLs of the application in the Casdoor admin console.

Learning outcomes​

What you need​

About the Casdoor API​

Choose an authentication method​

Authenticate with an access token​

Get the token​

Send the token​

Authenticate with a client ID and client secret​

Get the credentials​

Send the credentials with each request​

Exchange the credentials for an access token​

Authenticate with an access key and access secret​

Create a key​

Send the key​

Authenticate with a username and password​

Set the response language​

Sign a user out of all sessions​

Call the API from a browser​

See also​