Add Auth Function Endpoint

POST

/admin/add-auth-function

const url = 'https://example.com/admin/add-auth-function';
const options = {
  method: 'POST',
  headers: {'X-Tenzir-AdminKey': '<X-Tenzir-AdminKey>', 'Content-Type': 'application/json'},
  body: '{"tenant_id":"example","auth_fn":{"auth_fn":"auth_user","user_id":"example"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/admin/add-auth-function \
  --header 'Content-Type: application/json' \
  --header 'X-Tenzir-AdminKey: <X-Tenzir-AdminKey>' \
  --data '{ "tenant_id": "example", "auth_fn": { "auth_fn": "auth_user", "user_id": "example" } }'

Authorizations

Admin Key

Request Body^required

application/json

AddAuthFunctionRequest

object

tenant_id

required

Tenant Id

string

auth_fn

required

Any of:

UserAuthFunction

object

auth_fn

Auth Fn

string

default: auth_user

Allowed value: auth_user

user_id

required

User Id

string

Responses

200

Successful Response

application/json

Example ^generated

example

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example ^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}

Add Auth Function Endpoint

Authorizations

Request Body required

Responses

200

Example generated

422

Example generated

Request Body^required

Example ^generated

Example ^generated