Delete Auth Function Endpoint

POST

/admin/delete-auth-function

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

Fails silently if the index is out of bound

Authorizations

• Admin Key

Request Body ^required

Media type application/json

DeleteAuthFunctionRequest

object

tenant_id

required

Tenant Id

string

index

required

Index

integer

Example ^generated

{
  "tenant_id": "example",
  "index": 1
}

Responses

200

Successful Response

Media type application/json

Response Delete Auth Function Endpoint Admin Delete Auth Function Post

Array

Any of:

UserAuthFunction

UserAuthFunction

object

auth_fn

Auth Fn

string

default: auth_user

Allowed value: auth_user

user_id

required

User Id

string

EmailDomainFunction

EmailDomainFunction

Grants access for users from a specific connection (e.g. gmail) having email addresses from a given domain (e.g. @tenzir.com)

object

auth_fn

Auth Fn

string

default: auth_email_suffix

Allowed value: auth_email_suffix

connection

Any of:

string

string

null

null

email_domain

required

Email Domain

string

OrganizationRoleFunction

OrganizationRoleFunction

Grants access to users who have some role in some organization.

object

auth_fn

Auth Fn

string

default: auth_organization_role

Allowed value: auth_organization_role

connection

Any of:

string

string

null

null

roles_claim

required

Roles Claim

string

role

required

Role

string

organization_claim

required

Organization Claim

string

organization

required

Organization

string

OrganizationMembershipFunction

OrganizationMembershipFunction

Grants access to users that belong to some organization.

object

auth_fn

Auth Fn

string

default: auth_organization

Allowed value: auth_organization

connection

Any of:

string

string

null

null

organization_claim

required

Organization Claim

string

organization

required

Organization

string

AllowAllAuthFunction

AllowAllAuthFunction

object

auth_fn

Auth Fn

string

default: auth_allow_all

Allowed value: auth_allow_all

Example

[
  {
    "auth_fn": "auth_user"
  }
]

422

Validation Error

Media type 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"
    }
  ]
}