Hook Keys

The Hook Keys API provides operations to manage hook keys for your organization.

List all keys
OAuth 2.0: okta.inlineHooks.read

Lists all keys

Responses
200

Success

403

Forbidden

429

Too Many Requests

get/api/v1/hook-keys
Request samples 
Response samples 
application/json
[
  • {
    • "id": "HKY1i2htmXF5UNQhL0g4",
    • "keyId": "bb5bed7d-6e4d-488f-9c86-59b93a2bb3fb",
    • "name": "My new key",
    • "created": "2022-08-22T16:34:33.000Z",
    • "lastUpdated": "2022-08-22T16:34:33.000Z",
    • "isUsed": "true"
    },
  • {
    • "id": "HKY1p7jWLndGQV9M60g4",
    • "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad",
    • "name": "Test key",
    • "created": "2022-08-31T18:09:58.000Z",
    • "lastUpdated": "2022-08-31T18:09:58.000Z",
    • "isUsed": "false"
    }
]
Create a key
OAuth 2.0: okta.inlineHooks.manage
Creates a key for use with other parts of the application, such as inline hooks


Use the key name to access this key for inline hook operations.


The total number of keys that you can create in an Okta org is limited to 50.


Request 
Request Body schema: application/json
required
name
string
 
Responses 
200
Success


400
Bad Request


403
Forbidden


429
Too Many Requests


post/api/v1/hook-keys
Request samples 
application/json
{
  • "name": "string"
}
Response samples 
application/json
{
  • "id": "HKY1p7jWLndGQV9M60g4",
  • "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad",
  • "name": "My new key",
  • "created": "2022-08-31T18:09:58.000Z",
  • "lastUpdated": "2022-08-31T18:09:58.000Z",
  • "isUsed": "false",
  • "_embedded": {
    • "kty": "RSA",
    • "alg": "RSA",
    • "kid": "7fbc27fd-e3df-4522-86bf-1930110256ad",
    • "use": "null",
    • "e": "AQAB",
    • "n": "2naqCnv6r4xNQs7207lRtKQvdtnlVND-8k5iYBIiqoKGY3CqUmRm1jleoOniiQoMkFX8Wj2DmVqr002efF3vOQ7_gjtTatBTVUNbNIQLybun4dkVoUtfP7pRc5SLpcP3eGPRVar734ZrpQXzmCEdpqBt3jrVjwYjNE5DqOjbYXFJtMsy8CWE9LRJ3kyHEoHPzo22dG_vMrXH0_sAQoCk_4TgNCbvyzVmGVYXI_BkUnp0hv2pR4bQVRYzGB9dKJdctOh8zULqc_EJ8tiYsS05YnF7whrWEyARK0rH-e4d4W-OmBTga_zhY4kJ4NsoQ4PyvcatZkxjPO92QHQOFDnf3w`"
    }
}
Retrieve a public key
OAuth 2.0: okta.inlineHooks.read
Retrieves a public key by keyId


Request 
path Parameters
publicKeyId
required
string
id of the Public Key


 
 Example:  FcH2P9Eg7wr0o8N2FuV0
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/hook-keys/public/{publicKeyId}
Request samples 
Response samples 
application/json
{
  • "_embedded": {
    • "kty": "RSA",
    • "alg": "RSA",
    • "kid": "7fbc27fd-e3df-4522-86bf-1930110256ad",
    • "use": null,
    • "e": "AQAB",
    • "n": "2naqCnv6r4xNQs7207lRtKQvdtnlVND-8k5iYBIiqoKGY3CqUmRm1jleoOniiQoMkFX8Wj2DmVqr002efF3vOQ7_gjtTatBTVUNbNIQLybun4dkVoUtfP7pRc5SLpcP3eGPRVar734ZrpQXzmCEdpqBt3jrVjwYjNE5DqOjbYXFJtMsy8CWE9LRJ3kyHEoHPzo22dG_vMrXH0_sAQoCk_4TgNCbvyzVmGVYXI_BkUnp0hv2pR4bQVRYzGB9dKJdctOh8zULqc_EJ8tiYsS05YnF7whrWEyARK0rH-e4d4W-OmBTga_zhY4kJ4NsoQ4PyvcatZkxjPO92QHQOFDnf3w`"
    }
}
Retrieve a key
OAuth 2.0: okta.inlineHooks.read
Retrieves a key by hookKeyId


Request 
path Parameters
hookKeyId
required
string
id of the Hook Key


 
 Example:  XreKU5laGwBkjOTehusG
Responses 
200
Success


403
Forbidden


404
Not Found


429
Too Many Requests


get/api/v1/hook-keys/{hookKeyId}
Request samples 
Response samples 
application/json
{
  • "id": "HKY1p7jWLndGQV9M60g4",
  • "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad",
  • "name": "My new key",
  • "created": "2022-08-31T18:09:58.000Z",
  • "lastUpdated": "2022-08-31T18:09:58.000Z",
  • "isUsed": "false"
}
Replace a key
OAuth 2.0: okta.inlineHooks.manage
Replaces a key by hookKeyId


This request replaces existing properties after passing validation.


Note: The only parameter that you can update is the name of the key, which must be unique at all times.


Request 
path Parameters
hookKeyId
required
string
id of the Hook Key


 
 Example:  XreKU5laGwBkjOTehusG
Request Body schema: application/json
required
name
string
 
Responses 
200
Success


400
Bad Request


403
Forbidden


404
Not Found


429
Too Many Requests


put/api/v1/hook-keys/{hookKeyId}
Request samples 
application/json
{
  • "name": "string"
}
Response samples 
application/json
{
  • "id": "HKY1p7jWLndGQV9M60g4",
  • "keyId": "7fbc27fd-e3df-4522-86bf-1930110256ad",
  • "name": "My updated new key",
  • "created": "2022-08-31T18:09:58.000Z",
  • "lastUpdated": "2022-08-31T18:16:59.000Z",
  • "isUsed": "false"
}
Delete a key
OAuth 2.0: okta.inlineHooks.manage
Deletes a key by hookKeyId. After being deleted, the key is unrecoverable.


As a safety precaution, only keys that aren't being used are eligible for deletion.


Request 
path Parameters
hookKeyId
required
string
id of the Hook Key


 
 Example:  XreKU5laGwBkjOTehusG
Responses 
204
No Content


403
Forbidden


404
Not Found


429
Too Many Requests


delete/api/v1/hook-keys/{hookKeyId}
Request samples 
Response samples 
application/json
{
  • "errorCode": "E0000006",
  • "errorSummary": "You do not have permission to perform the requested action",
  • "errorLink": "E0000006",
  • "errorId": "sampleNUSD_8fdkFd8fs8SDBK",
  • "errorCauses": [ ]
}