Skip to main content
POST
Create an organisation key

Authorizations

X-Tyk-Authorization
string
header
required

Api key

Path Parameters

keyID
string
required

The Key ID

Query Parameters

reset_quota
enum<string>

Adding the reset_quota parameter and setting it to 1, will cause Tyk reset the organisations quota in the live quota manager, it is recommended to use this mechanism to reset organisation-level access if a monthly subscription is in place.

Available options:
1

Body

application/json
access_rights
object | null
alias
string
Example:

"portal-developer@example.org"

allowance
number<double>
Example:

1000

apply_policies
string[] | null
Example:
apply_policy_id
string
deprecated

deprecated use apply_policies going forward instead to send a list of policies ids

Example:

"641c15dd0fffb800010197bf"

basic_auth_data
object
certificate
string
data_expires
integer<int64>
Example:

0

date_created
string<date-time>
Example:

"2024-03-13T03:56:46.568042549Z"

enable_detail_recording
boolean
deprecated

deprecated use enable_detailed_recording going forward instead

Example:

false

enable_detailed_recording
boolean
Example:

true

enable_http_signature_validation
boolean
Example:

false

expires
integer<int64>
Example:

1712895619

hmac_enabled
boolean
Example:

false

hmac_string
string
id_extractor_deadline
integer<int64>
is_inactive
boolean
Example:

false

jwt_data
object
last_check
integer<int64>
Example:

0

last_updated
string
Example:

"1710302206"

max_query_depth
integer
Example:

-1

meta_data
object | null
Example:
monitor
object
oauth_client_id
string
oauth_keys
object | null
org_id
string
Example:

"5e9d9544a1dcd60001d0ed20"

per
number<double>
Example:

5

quota_max
integer<int64>
Example:

20000

quota_remaining
integer<int64>
Example:

20000

quota_renewal_rate
integer<int64>
Example:

31556952

quota_renews
integer<int64>
Example:

1710302205

rate
number<double>
Example:

1

rsa_certificate_id
string
session_lifetime
integer<int64>
Example:

0

smoothing
object | null
tags
string[] | null
Example:
throttle_interval
number<double>
Example:

10

throttle_retry_limit
integer
Example:

1000

Response

OK

action
string
Example:

"modified"

key
string
Example:

"b13d928b9972bd18"

key_hash
string
status
string
Example:

"ok"