Introduction
This is the NetFoundry Auth service
Overview
HTTP verbs
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP verbs.
Verb | Usage |
---|---|
|
Used to retrieve a resource |
|
Used to create a new resource |
|
Used to update an existing resource, full updates only |
|
Used to delete an existing resource |
The PATCH method is not used (yet).
|
HTTP status codes
NetFoundry adheres closely to standard HTTP and REST conventions in its use of HTTP status codes.
Status code | Usage |
---|---|
|
The actual response will depend on the request method used. In a GET request, the response will contain an entity corresponding to the requested resource. In a POST request, the response will contain an entity describing or containing the result of the action. |
|
The request has been fulfilled and resulted in a new resource being created. |
|
The request has been accepted and is being processed asynchronously Standard response for successful HTTP requests which invoke back-end services. |
|
The server successfully processed the request, but is not returning any content. |
|
The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing). |
|
The request lacks valid authentication credentials for the target resource. |
|
The request is authenticated with valid credentials however that set of credentials is not authorized to access this resource. |
|
The requested resource could not be found but may be available again in the future. Subsequent requests by the client are permissible. |
Pagination
Paginated services will accept the following optional request parameters:
Path | Type | Optional | Description |
---|---|---|---|
page |
Integer |
true |
Page you want to retrieve, 0 indexed and defaults to 0. |
size |
Integer |
true |
Size of the page you want to retrieve, defaults to 1000. |
sort |
String |
true |
Properties that should be sorted by in the format |
Pagination response has following structure:
Path | Type | Optional | Description |
---|---|---|---|
content |
Array[Object] |
false |
Actual items. |
totalElements |
Integer |
false |
Total count. |
totalPages |
Integer |
false |
Total pages with current page size. |
last |
Boolean |
false |
If this page is the last one. |
numberOfElements |
Integer |
false |
Actual size of content array (number of items). |
first |
Boolean |
false |
If this page is the first one. |
sort |
Object |
true |
Sort information object. |
size |
Integer |
false |
Requested size of the page. |
number |
Integer |
false |
Page number. |
empty |
booloean |
false |
If this page is empty. |
Authorization
Masquerade
POST /masquerade
Authorization
Authorization not required for this request.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
identityId |
String |
true |
Must not be null. |
audience |
String |
true |
Must not be empty. |
claims |
Map |
true |
Must not be null. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
token |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/masquerade' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ0RDRzUkIzcUJxY29nV3poUEVYeEh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI5OTc2NGJlLTJhZGUtNDY5Mi1iMzk4LTY4MTZjY2FkNWRhNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNCwiZXhwIjoxNzU5NDIxMTM0LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcIjQzMGQ3Y2UzLWU5N2QtNDBiZC1iMjdhLWExZTA1YzMzZGQ1M1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzNH1dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNGM4ZTBkNTMtZDJlZS00NGE1LWE4YzgtYjQ5YzU1NTQ4NDAwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiYTU1NTc5ZWYtOGNkNi00MWE4LWE0YmQtYjczNTMxZGNlMmZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA5fSx7XCJpZFwiOlwiZmNhMmZmZTgtZTEzNC00ZTEyLWIzZmEtZDIxMmVhMjg4MGYwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiYTNkMzM3ODUtOTkzZS00NGQ2LWI2ZDAtMDk5NTQ1NGFjMDNiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiMTY2NGE5MGUtOTM0NS00NDdhLWIyMDUtMTBmZDAxOTA1N2Q3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA3fSx7XCJpZFwiOlwiNTQ0YTA1OGItM2VmYi00ZDYzLTk3NzAtOGI2NGQxYzNhMWRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiNmQwM2IwYzEtZDg1Yi00YzI4LWFjYjgtNTM5OTRjODFkZTNmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA4fSx7XCJpZFwiOlwiNTBmOGY2ZjYtZjY0Mi00ZGNlLWJkMjAtMjBiNDkxNDQ0NjZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA3fSx7XCJpZFwiOlwiNmQyYjZkOTAtNDg2OS00Y2QxLWFjNGMtNGMzM2U5MzVmNGIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTIzfSx7XCJpZFwiOlwiNzgwMGYyYjEtNGMyZC00MmFiLWI1YzItYjhkNGNlNzRlYjFiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.nOxoP2LkRA_kjcIoWcOkcjF9wrHS7-pv8T7UABwMPa4u0dJsuG8CbZLXrp0SC1MlOZOel_HBlTaIkqwPnneRgLsiS2AqmmVcb1I0N7mXQXTOBTUu2Xmj1BL_jiSG-bzfHAXNvwKaLj85u_DIi93kyWmZ4Ghco2EfSXNeQWdtzUKXBJS47pNZgqRIrP5xCZf6NKvleO3ZOptNuEW0yhi7EUO_fxiRTsrJ2wmFT5tYWSMH2EyoanVLg_JLl6QWC_vC1RH86AcPoQg3a_o4RxSBM_ZlZ6VwmQ727AdSw4VysdB2W77mIrPslyuTDlWLDFreLPstQA6V8u-hyquaXNlTDA' \
-d '{"identityId":"49dd56da-e414-43dd-9570-a6e316329cad","audience":"io.netfoundry.test","claims":{}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1950
{
"token" : "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJoRXY3SkFKQ3Vma2xRMWtTNWhIUmFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQ5ZGQ1NmRhLWU0MTQtNDNkZC05NTcwLWE2ZTMxNjMyOWNhZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkudGVzdCIsImlhdCI6MTc1OTQxNzUzNCwiZXhwIjoxNzU5NDE3ODM0LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImNjODk2Yzc5LTQxNmUtNGFkMi04ZjM1LWJhZGUxNmNmZTgzZFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM31dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNGM4ZTBkNTMtZDJlZS00NGE1LWE4YzgtYjQ5YzU1NTQ4NDAwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiYTU1NTc5ZWYtOGNkNi00MWE4LWE0YmQtYjczNTMxZGNlMmZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA5fSx7XCJpZFwiOlwiZmNhMmZmZTgtZTEzNC00ZTEyLWIzZmEtZDIxMmVhMjg4MGYwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiYTNkMzM3ODUtOTkzZS00NGQ2LWI2ZDAtMDk5NTQ1NGFjMDNiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiMTY2NGE5MGUtOTM0NS00NDdhLWIyMDUtMTBmZDAxOTA1N2Q3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA3fSx7XCJpZFwiOlwiNTQ0YTA1OGItM2VmYi00ZDYzLTk3NzAtOGI2NGQxYzNhMWRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiNmQwM2IwYzEtZDg1Yi00YzI4LWFjYjgtNTM5OTRjODFkZTNmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA4fSx7XCJpZFwiOlwiNTBmOGY2ZjYtZjY0Mi00ZGNlLWJkMjAtMjBiNDkxNDQ0NjZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA3fSx7XCJpZFwiOlwiNmQyYjZkOTAtNDg2OS00Y2QxLWFjNGMtNGMzM2U5MzVmNGIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTIzfSx7XCJpZFwiOlwiNzgwMGYyYjEtNGMyZC00MmFiLWI1YzItYjhkNGNlNzRlYjFiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.AIG6g5Bsix9W9ZlWoD6OvHz9qVObKxRJVMqauX6KfBWdRv5ZMUHVqkQeIl7A9ZFGmm7_ywXhmoFMhEJtJLcXEjXkSjs0JlIoVdKyZhLAUh6VnqUVmxVrzjFj0OMGOCkrJ2RT0hXXnGCjdTe6B4aA-cSVF82eDs7x_w5Mf127PHzPhN6SGUX9DMrxOfOJr_N3zOmok3vRxoFH4mNIr8WJIxV3fk2rMDDFjwq9Ta6YchnfiIgxV5cdHAwcTOtI-RrF7ZILMUGfAcwNO7ML4q7jCJRLheA5zyEt21nbE3u3MEO8mx37nkFnLJ8oqlaklrjnvwyFanx2iMGDe6EzxkwF0Q"
}
Core Authorization Resources
Domains
Find Domains
GET /domains
Authorization
This endpoint requires read
action on the domain
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].name |
String |
true |
Must not be null. |
[].code |
String |
true |
Must match the regular expression |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/domains' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ3UHREZVBsbmZfZ3JFeXljQ1VtU0F3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQzMzkyYWEzLTZiZDYtNGE1NC04ZjI2LWU2YzJkNDBmOGQ2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNywiZXhwIjoxNzU5NDIxMTM3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjhmNmFiYWUtZTMyNS00YmVmLWJmYzItNGY1NTEyYjBkNWY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.e8dvr3Ljd_3SJPtSFLEz-qZJPRiJAhgQOQfMoWXJ0jv3uwts2qFCUt7LB7q6psBWtuR4yiam-sa1Zl3zLTL8xvjIfjERBwOUOuG_HFMKygNg0Usz9mRojBuugu-_DtDFgqp77aN45x9BhEI1-IaB7DgRqal8geUx39AmapEtCuz0ATXqsyVkFX605fvn9dlrhTs-nFn6jf2l5GNwhroc6Tm7MHQfrMwpxlVT63sTNdwk928x6jC1rSAuRRej8ge1i16WWGHGBLv18w8jQ56A22BceYMUzjQ4Zdc1nyy2MQIvhlsmKUaXrBCtGlZgHBFBLfCEKUL-wf0QgomcssWxNg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 877
[ {
"id" : "e56f9f32-17d6-45ce-97a3-bf88d8a2c79a",
"name" : "Test Domain 28",
"code" : "test.domain.28",
"createdBy" : "8f735352-d41e-4e65-85fb-84e21159d52d",
"createdAt" : "2025-10-02T15:05:35.650431Z",
"updatedAt" : "2025-10-02T15:05:35.650431Z",
"_title" : "Test Domain 28"
}, {
"id" : "a5e9c7b1-3a74-49b6-aabf-c61a2b628a46",
"name" : "Management",
"code" : "io.netfoundry.management",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.051151Z",
"updatedAt" : "2025-10-02T15:05:09.051151Z",
"_title" : "Management"
}, {
"id" : "1bba4311-adc8-4597-bb9a-3ac7cecc158c",
"name" : "Test Domain 7",
"code" : "test.domain.7",
"createdBy" : "354adce2-62b8-435f-8077-b3708c553350",
"createdAt" : "2025-10-02T15:05:27.579769Z",
"updatedAt" : "2025-10-02T15:05:27.579769Z",
"_title" : "Test Domain 7"
} ]
Get Domain
GET /domains/{idOrCode}
Authorization
This endpoint requires read
action on the domain
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
idOrCode |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/domains/5ccb4e63-1623-4888-8cc5-2ad7f4045542' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiI0Q1VUWGxVX3FONjZNYm00MElaSXh3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM4N2Y4NmM0LWY2ZGQtNGU1Zi05MzhjLWY0ZjE4M2YzZWZjMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNywiZXhwIjoxNzU5NDIxMTM3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODM1ZWNiODktMmI0OC00MzUwLTg3NmItZmExNDJkZjk2ZjQ1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.uLDgcTgWM8w6NslgfxWJm6Q8KrKFAHfb4Dga3we18H7YJgBLoJG6FQqDcMc94cFWs8TQ7nygpo_RK_GlZJs-clRxpg-03cxesdWv_R6R33dZc9eVmpNDUvQmPQLaLLf3OPQq0JkbyFPP99FDZaBbLlyUOBSXtUwdWZq9UfRfG0VuhJJYsvByK9cG7M9a3IX3Y8ShPBoTk7ECBocGgHrCn7uUj0n0iWs62cuTvgV3DYOs4RoCBfCCM1Va_3vxeUBR7oxCZ1ZJIjP345DdeKYOEu8YR76Xsq6FiiHi4uEOWcqvarU5aC6S5OTIq-uV4ykuhktRcCM9rHaeK9M3eDSN_g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 288
{
"id" : "5ccb4e63-1623-4888-8cc5-2ad7f4045542",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "c9b30ba9-0f19-4bf3-aa75-c1db91ddfcaa",
"createdAt" : "2025-10-02T15:05:23.576491Z",
"updatedAt" : "2025-10-02T15:05:23.576491Z",
"_title" : "Test Domain"
}
Get Domain
GET /domains/{idOrCode}
Authorization
This endpoint requires read
action on the domain
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
idOrCode |
String |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/domains/io.netfoundry.test' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJxbEZ3YzFYSlpVX2lrQV90SHh1blNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFkZDAxZmI1LWUyOGEtNDNkZC1hMmQzLTgwNmY0YjA4ZTM4OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNywiZXhwIjoxNzU5NDIxMTM3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWY5MmFlNjUtZDVmNi00YzUyLTg0ZjItMDY2YzQyMDJiYTEzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.WCmzuoqOMu_B2goiXXw3FLtUvX8jnDFCdrg-SATCgJ768DdbO5uPA-swpmNl99aG3xaSzaBSjFekG0lUBqHalSjTlHJI0-Xic2Cgz9Y4kyiFKZ1wD4qTicwQYGxxZSR9uc7lbas2ZUWmUwwlk0a8c6fPazDik3IgFXxDQ3axChCiYkI9OdngO9g0pnbM3bq8N6QIl1VCmQenNmfXSO-PlZKj83rVtHcjlFKaEyA_G_7gzM7cUnjXx8XtzqMNdC58gbnJN5zOuhCPPLDnG_FW6Q2Om5QyHSPHw19eyWF3ifoRedaCogLbD9815APOenM1iAld-YO2Ef4YRKIfswP1Vw'
Example response
HTTP/1.1 200 OK
Content-Disposition: inline;filename=f.txt
Content-Type: application/json
Content-Length: 288
{
"id" : "5ccb4e63-1623-4888-8cc5-2ad7f4045542",
"name" : "Test Domain",
"code" : "io.netfoundry.test",
"createdBy" : "c9b30ba9-0f19-4bf3-aa75-c1db91ddfcaa",
"createdAt" : "2025-10-02T15:05:23.576491Z",
"updatedAt" : "2025-10-02T15:05:23.576491Z",
"_title" : "Test Domain"
}
Create Domain
POST /domains
Authorization
This endpoint requires create
action on the domain
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/domains' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJCN3l5ZUttUWt6Rnl2NC1XM2tBTXNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFhYmYyMzc3LWQ2ODYtNGNmZi04MGYzLTRhYmYyZDEyMTUwNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNywiZXhwIjoxNzU5NDIxMTM3LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTI3MGY1YWMtMTRiZi00NzhjLWI5YWMtNmRlNzZjNjRjYzA2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM3fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.PXFXL2FsTt13fp_TGdB05dNZlq56Fl8G0lm8oXyEnq5qkb4-mh7PGfWgZ_soJNfhQGDO_VIxDt25-dId15xjb8o7qObKtI_aREzQf2verByqQcNhBo2i2eljs3YYBNqQ_WPaGJ-DnrQvAPBkbxZTDsICqgV0VMee45mu-cQPMtdaZRDV_TMQfHRL6o3TJaNUADqtkWUBe7hNLtPeZgbSXzhrxs9g2h2Tk9xqtMdql9PaMJMgtD0T7h4XZTGJmmKibYiBlU2yx9aM6PYobWuX6ZrPIBE6HtbkJkif4-_my1KfCCvpm0RMIQI4lOsOyXmkNPpGGsW3wnFGHRxE2HQVqQ' \
-d '{"name":"Other Test Domain","code":"other.test.domain"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 299
{
"id" : "d8e8412c-a5c5-437c-83c5-7030f6c301ff",
"name" : "Other Test Domain",
"code" : "other.test.domain",
"createdBy" : "1abf2377-d686-4cff-80f3-4abf2d121504",
"createdAt" : "2025-10-02T15:05:37.533968Z",
"updatedAt" : "2025-10-02T15:05:37.533968Z",
"_title" : "Other Test Domain"
}
Resource Types
Find Resource Types
GET /resource-types
Authorization
This endpoint requires read
action on the resource-type
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
domainId |
Object |
true |
|
code |
Object |
true |
|
parentId |
Object |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].domainId |
String |
true |
Must not be null. |
[].name |
String |
true |
Must not be null. |
[].code |
String |
true |
Must match the regular expression |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].parentId |
String |
true |
|
[].root |
Boolean |
true |
|
[].depth |
Integer |
true |
|
[].childrenIds |
Array[Object] |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/resource-types' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ6ZFVScXZSMTBHVkl6N08wSUxVVFFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA1ODFmZDRhLTRiNzAtNDc2MS1hMzIyLTllNjViM2FiY2M1NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOSwiZXhwIjoxNzU5NDIxMTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2FiMmM2NjYtNWEwNC00OTY1LTk5NWUtM2I1OTNiYjU4OGI5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.oa-1YqGEoIVk9ZSRwUJsk7_WHEm_xYtZNkkfFMc8SKPZ4Qt26hq2w-WSfwXMaUMEIK_xSEsn5AwtSVp4JgD3s8o_1-aw6zhqJSZNZE3do6rMVK6Ajuv2E9MfhaC4xgPeGz0EabpLNOvvxlgmYrXbdJmhXg1jOWjPD8lNjZ1xHCaglyslfJAHJUoLogRJplVYla9ernE1WFyEbj7gBO4GKVzgelU3mhloHtUkrnGVOCiFfyraXKsztJuS81lJ8RcQeItJQ1dx8JvPt-ZRb_lIL9LkT8n152qnopHyAGbrGu4hWzxTjBDAN2oTPFYg2LLPihS7A0qxgZ1Q3dX18XqL3w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1418
[ {
"id" : "00533fc0-d4af-4fe3-973a-128e2e155911",
"domainId" : "1cd6abc1-0175-43ba-8699-6334c8611d4c",
"name" : "User Identity OIDC Audience Mapping",
"code" : "user-identity-oidc-audience-mapping",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:10.335001Z",
"updatedAt" : "2025-10-02T15:05:10.335001Z",
"parentId" : "03fa3f53-1862-4351-aa3d-68ce00d953b5",
"root" : false,
"depth" : 2,
"childrenIds" : [ ],
"_title" : "User Identity OIDC Audience Mapping"
}, {
"id" : "e8609204-c2d1-4f8b-bc3e-8ac1eeb6dcc4",
"domainId" : "251ce4a6-c3f1-4b47-9107-2c0baf2ab04e",
"name" : "Service",
"code" : "service",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:06.045207Z",
"updatedAt" : "2025-10-02T15:05:06.045207Z",
"parentId" : "f42550b3-a5f4-406f-808d-c445d4f18c80",
"root" : false,
"depth" : 2,
"childrenIds" : [ ],
"_title" : "Service"
}, {
"id" : "4575aad4-f3ab-4956-94f5-cc4a6dabe4b6",
"domainId" : "251ce4a6-c3f1-4b47-9107-2c0baf2ab04e",
"name" : "Service Policy",
"code" : "service-policy",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:07.916504Z",
"updatedAt" : "2025-10-02T15:05:07.916504Z",
"parentId" : "f42550b3-a5f4-406f-808d-c445d4f18c80",
"root" : false,
"depth" : 2,
"childrenIds" : [ ],
"_title" : "Service Policy"
} ]
Get Resource Type
GET /resource-types/{id}
Authorization
This endpoint requires read
action on the resource-type
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
domainId |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
parentId |
String |
true |
|
root |
Boolean |
true |
|
depth |
Integer |
true |
|
childrenIds |
Array[Object] |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/resource-types/453b0e75-783f-4e7a-908f-e6cdd7a7b6de' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJYalFvdDFNclRDc1hVbUZmclJ0ZmZRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU4OTdlMjVhLTRhZjMtNDdhNy04YjI4LTA4NmI4NTQxOTFkMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOSwiZXhwIjoxNzU5NDIxMTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTdmYWVkM2MtOTE1OS00Zjg2LTliZTctYzg3ZDcxN2I5ZGYyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.H-8HWytSDAKCnjoiDdZNQcTcy5Cr2Ec-pgas8SzlwBBc3UQ_TTmsEiJ7puTOQSyrs6YKL_epJP2YwIGAi7jvDCM_l5yMwCohRXf1a4RGuVoTKFpMDbW06CQS2sQGn2DM_FKpUNlvc-EdWFvp92uU4oaHR-uDFOtc94w47hFNGiz4pYTfLakxCpP8mhqgkrt4g8zqpdhMosZGCKBjODCg3pM72RER2yRPJXj1GZs3aGI8YVL6DDqk0kjIYxh86KOKy-iKEsjUgi3x75jik8enJYupQop3DkHv00sloM9q-Q_TrRw-ca84bDG245Prv9K_mTCsDeY4vCQ61kj17-Q0Ng'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 406
{
"id" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de",
"domainId" : "5ccb4e63-1623-4888-8cc5-2ad7f4045542",
"name" : "Test Type",
"code" : "test-type",
"createdBy" : "ddcdbdd1-3d75-4b66-b16f-f3e1aae6449b",
"createdAt" : "2025-10-02T15:05:23.684181Z",
"updatedAt" : "2025-10-02T15:05:23.684181Z",
"parentId" : null,
"root" : true,
"depth" : 0,
"childrenIds" : [ ],
"_title" : "Test Type"
}
Create Resource Type
POST /resource-types
Authorization
This endpoint requires the following actions:
-
create
action on theresource-type
resource type -
read
action on thedomain
resource type -
read
action on theresource-type
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
domainId |
String |
true |
Client must have |
parentId |
String |
true |
Client must have |
resourceType |
Object |
true |
Must not be null. |
resourceType.name |
String |
true |
Must not be null. |
resourceType.code |
String |
true |
Must match the regular expression |
resourceType.children |
Array[Object] |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
domainId |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
parentId |
String |
true |
|
root |
Boolean |
true |
|
depth |
Integer |
true |
|
childrenIds |
Array[Object] |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/resource-types' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiIzZWVmVlN2RXplcFhPYjlPdDhad01nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjU1ZjEwYWJkLTA4ZjctNGIyNC04OTYxLTE0MjAxYjZmZDgyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MCwiZXhwIjoxNzU5NDIxMTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMWMwOGEwMWQtYjA1Yi00NTJlLWE3Y2YtMmU1NzRjMmExOGI2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfSx7XCJpZFwiOlwiMDg2Mzk3M2EtMGI1NC00NDRhLWIxOTctNGMyZWJiMjMzMjE5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfSx7XCJpZFwiOlwiYTA5YjhjOGItOTQwZC00NWZmLThlYTMtY2Q3NWFjZDZiM2ZiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.hbOo4kMUOJRIju948NhmG4t17VPK-fqA61RMOlJGpNaRKC-6ST12Gn_THL2VockgEju4Ov0kOTL4GY9BiVC8LcmbGkQ1Hg5-sWLgyC_gOokt11Hl_p02Kxf2xjFkkicV9xezN2V0J5qr_b8g7ME25Al3yTzEwwnsMoMb83zcu4r0Q2u0uTP_gtXbUuxZK2S7CZs-vbSawCwa2G-wuz8uho0QmVYJo84YVMrMx-mOXS6rG2wr8yTuwEGBAAqrOVKrgNEtjwhLykhERcFS87HDQOEuxpGvmpgpWuYsBejNyIgfCWgpGnNgoMWhlYWb-lCranmL1po7Hdk3OouK0pxZUg' \
-d '{"domainId":"5ccb4e63-1623-4888-8cc5-2ad7f4045542","parentId":"453b0e75-783f-4e7a-908f-e6cdd7a7b6de","resourceType":{"name":"Another Test Type","code":"anoter-test-type","children":[]}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 464
{
"id" : "819312bd-4014-49dc-9a83-abc8c8f8515c",
"domainId" : "5ccb4e63-1623-4888-8cc5-2ad7f4045542",
"name" : "Another Test Type",
"code" : "anoter-test-type",
"createdBy" : "55f10abd-08f7-4b24-8961-14201b6fd820",
"createdAt" : "2025-10-02T15:05:40.153164Z",
"updatedAt" : "2025-10-02T15:05:40.153164Z",
"parentId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de",
"root" : false,
"depth" : 1,
"childrenIds" : [ ],
"_title" : "Another Test Type"
}
Resource Actions
Find Resource Actions
GET /resource-actions
Authorization
This endpoint requires read
action on the resource-action
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
code |
Object |
true |
|
resourceTypeId |
Object |
true |
|
domainId |
Object |
true |
|
customRoleId |
Object |
true |
|
standardRoleTypeId |
Object |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceTypeId |
String |
true |
Must not be null. |
[].name |
String |
true |
Must not be null. |
[].code |
String |
true |
Must match the regular expression |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].standardAction |
Boolean |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/resource-actions' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJrZTAyWEtuTHRXNGFOWEpkb2NWTzlnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhkN2U3ZjI1LWRiYTYtNDY2MC1iOTQ4LTBlMTNmNjA4NWNhMyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOSwiZXhwIjoxNzU5NDIxMTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZmFiNjg4NTItZTYxYi00NDQyLWEwY2MtZWI5NTBhMTBmNTUwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jmlDFjIMMorinOF4gQi2ZLUIJlKEC87oMduuSU0M-NUJjBcfL9PektotoiMUTSih3yE3zg-Icu-B9eIg7Vu5MsNInXu0OvPTNvXUZ5Mf1JaotWg1ezDvOw5YpDs2PGdyFXIGUHLkfRSHp19jd1mpBAC1FCnt3ZxH89y46inKOse9CjthkhWkhGYZ07v9sfazZMgWQiMJW2IHjHlnB_RmpnXfdECMmZokWwVGUu1y6SnooYVo1zQheP_zFrn9jrTypAF4w-gTYqvX-BpybTRs6aFgSdmN7Yb0K5k5exYPBiZdMIEVmmNmTa1GDMZPxd7FgecAFg3xmdsq5odAOVHliQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1213
[ {
"id" : "6cb36832-ba43-44ad-9dd0-74edb899f0af",
"resourceTypeId" : "ac00cfa5-41a2-4707-9b7f-950de6f52ea7",
"name" : "Delete",
"code" : "delete",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:06.737107Z",
"updatedAt" : "2025-10-02T15:05:06.737107Z",
"standardAction" : true,
"_title" : "Delete Custom Role"
}, {
"id" : "16e46bd2-a681-4cd1-94cc-7502c4c7f678",
"resourceTypeId" : "e77f526a-8878-4c59-8ae6-6919b98eef42",
"name" : "Read Network Host",
"code" : "read-network-host",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.636297Z",
"updatedAt" : "2025-10-02T15:05:09.636297Z",
"standardAction" : false,
"_title" : "Read Network Host Network Host"
}, {
"id" : "8bc4ec0c-f1db-4c8e-94e8-a32e5549f094",
"resourceTypeId" : "e20f526a-8878-4c59-8ae6-6919b98eef37",
"name" : "Create Edge Router Upgrade",
"code" : "create-edge-router-upgrade",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.631012Z",
"updatedAt" : "2025-10-02T15:05:09.631012Z",
"standardAction" : false,
"_title" : "Create Edge Router Upgrade Deployment-Edge Router"
} ]
Get Resource Action
GET /resource-actions/{id}
Authorization
This endpoint requires read
action on the resource-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceTypeId |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
code |
String |
true |
Must match the regular expression |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
standardAction |
Boolean |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/resource-actions/9120c25d-c1ab-49c1-a913-ecc9b66fc998' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiI4Zi13V25fV3lJTEZIOW9BTGdsRlBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjM1ZGIxMjdjLTYwYjYtNGMyMy05NzU2LWE1Yjk0YjNiYTY0OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOSwiZXhwIjoxNzU5NDIxMTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTcwMzk1ZDUtMWU0OS00ODMyLWEwODMtOTQwMGZiYTZmYWY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jZjrG57jsxYqcOvKc3DeGw5Vt0pf1RW1aBJ20mIXohdNgjsvgZOsJl-3TXpRQo3JxZyx3a0BqqL0s9Ln6mdR_cBbthfXNXz7D7Rnvr2pVJzleFiF-uhHJTPH4_1muxFBeGs9ZTo2jyZKs08v8XrNS25hpjHjHxdR3OZoudvbHgnV9KPrNq7m4DcJ7J8C356jPo3fRaH3Vwi90djRyEB6qTeZnya_XIK6FkCGE91sLyBZIQkvOEDlLJAYKT8DboFkIny8dG2rHXfdFsErNA_NPce9tHxUrdh4txKNlI6WntR54yw9WIdBjtjiC3Z2YLsbvvRbhH3WCXjWpHkOK4qDhQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 380
{
"id" : "9120c25d-c1ab-49c1-a913-ecc9b66fc998",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de",
"name" : "Test Action",
"code" : "test-action",
"createdBy" : "27022c4c-3af9-4193-ab9a-4d2644fcaffb",
"createdAt" : "2025-10-02T15:05:23.752528Z",
"updatedAt" : "2025-10-02T15:05:23.752528Z",
"standardAction" : false,
"_title" : "Test Action Test Type"
}
Create Resource Action
POST /resource-actions
Authorization
This endpoint requires the following actions:
-
create
action on theresource-action
resource type -
read
action on theresource-type
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
resourceTypeId |
String |
true |
Client must have |
actions |
Array[Object] |
true |
Must not be empty. |
actions[].name |
String |
true |
Must not be null. |
actions[].code |
String |
true |
Must not be null. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceTypeId |
String |
true |
Must not be null. |
[].name |
String |
true |
Must not be null. |
[].code |
String |
true |
Must match the regular expression |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].standardAction |
Boolean |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/resource-actions' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJTakFXLVVMNEJxSlVVa3NQS2JNMHZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ4YmIwZWY3LTQ2ODQtNDM2ZC1iOGNkLTViZWU0ODljODQxMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOSwiZXhwIjoxNzU5NDIxMTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODdjZmQ0M2UtYzdiOS00ZTA4LWExZmQtNWMzM2M1ZmU2MjM4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fSx7XCJpZFwiOlwiMDAyY2M1NTUtMGY5ZS00YzI1LWFkYTUtYmNiZWM1ZWI3ZTQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.sPohixxI6IVUL4V5Evt72x6vT7bAfJ5Uq-ezVfnt_AGLE5vWv_urMdPN3vHo9wiGZxdVvOoo2a4BBt3fokjr0-IwHoBjE-70pbG38ZVKPZh86ZofXOMGw_Aul4_mfwgSNLCBcHP7d73xcZ9ViqqrrAmvxO5Mkl5d7ANli5EcsKJZhFVZRuNgoiU6SQXP1rpOm9Lrniv5PnOhwBWS-6Bh94dK9pxAsUetZNYmYFxP_2tNgUnOWL2A1vlp80sFz-ZleohsaNCxFb5WURQg7G6_AjcqMd29Nz-pirq00LWaQbmdyKZUk9wLQ2YeReYxtkkiaJTUsdLKCZgFG_41O0rWzw' \
-d '{"resourceTypeId":"453b0e75-783f-4e7a-908f-e6cdd7a7b6de","actions":[{"name":"Update Custom","code":"update-custom"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 390
[ {
"id" : "d024abee-6bec-4f7a-b6e4-260f1f6f2f6a",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de",
"name" : "Update Custom",
"code" : "update-custom",
"createdBy" : "d8bb0ef7-4684-436d-b8cd-5bee489c8411",
"createdAt" : "2025-10-02T15:05:39.471736Z",
"updatedAt" : "2025-10-02T15:05:39.471736Z",
"standardAction" : false,
"_title" : "Update Custom Test Type"
} ]
Authorization Grants
Grants (abstract)
Find Grants
GET /grants
Authorization
Authorization not required for this request.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
grantType |
Object |
true |
|
identityId |
Object |
true |
|
resourceActionId |
Object |
true |
|
path |
Object |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].grantType |
String |
true |
Must be one of [CustomRole, IdentityResourceAction, PublicGrant, SuperUser]. |
[].grantId |
String |
true |
|
[].privilegeSourceId |
String |
true |
|
[].identityId |
String |
true |
|
[].privileges |
Map |
true |
|
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/grants' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJtekIwUGRLVS13c0JZd2JhUXJpTnF3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhmMDQ1MDJhLThjMTQtNDA3NC1hYzM1LWJlOGE4ZDNiMzhlZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNywiZXhwIjoxNzU5NDIxMTM3LCJncmFudHMtc3VwZXIiOiJbe1wiaWRcIjpcImM4ZDMzNGUyLTY1ZTgtNDM1Mi04MDk1LTA1NDExNTI1NmJjNFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzN31dIiwiZ3JhbnRzLWN1c3RvbSI6IltdIiwiZ3JhbnRzLXB1YmxpYyI6Ilt7XCJpZFwiOlwiNGM4ZTBkNTMtZDJlZS00NGE1LWE4YzgtYjQ5YzU1NTQ4NDAwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiYTU1NTc5ZWYtOGNkNi00MWE4LWE0YmQtYjczNTMxZGNlMmZlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA5fSx7XCJpZFwiOlwiZmNhMmZmZTgtZTEzNC00ZTEyLWIzZmEtZDIxMmVhMjg4MGYwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiYTNkMzM3ODUtOTkzZS00NGQ2LWI2ZDAtMDk5NTQ1NGFjMDNiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiMTY2NGE5MGUtOTM0NS00NDdhLWIyMDUtMTBmZDAxOTA1N2Q3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA3fSx7XCJpZFwiOlwiNTQ0YTA1OGItM2VmYi00ZDYzLTk3NzAtOGI2NGQxYzNhMWRiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fSx7XCJpZFwiOlwiNmQwM2IwYzEtZDg1Yi00YzI4LWFjYjgtNTM5OTRjODFkZTNmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA4fSx7XCJpZFwiOlwiNTBmOGY2ZjYtZjY0Mi00ZGNlLWJkMjAtMjBiNDkxNDQ0NjZhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA3fSx7XCJpZFwiOlwiNmQyYjZkOTAtNDg2OS00Y2QxLWFjNGMtNGMzM2U5MzVmNGIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTIzfSx7XCJpZFwiOlwiNzgwMGYyYjEtNGMyZC00MmFiLWI1YzItYjhkNGNlNzRlYjFiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTA2fV0iLCJncmFudHMtYWN0aW9uIjoiW10iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.YOPojWdb9F3Bh_O66olsVS_G6P4pi4uZRP_4LtyiyDBRdcUQx9KLrg9XJRtYFW_6NKTBP_8m4c16u6tnnkGkrNV6vcFqYZa2HIuKSm6-jRJEF5mh1UMikF1W-AkIdIDKGPDSv-j0fE9rIgmipI5XmqromE1iWKfQImBAbFn0nveD5Av0rdF5uWarToVcVZ_LP_m5KgWsNY24Z5LlKpGeHsL5xEp87NUxDQPUB3vKLJvDhllpeGO66xKhQFDH6lUyEmvwOlaFeCv1aGk6CPZl_gOBPz9BVjPd9NfrmjkPh5zWMXXbVDg5vwG7rnuQpAUvBaVjlM031DPWE7rzhVBQOg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1759
[ {
"grantType" : "IdentityResourceAction",
"grantId" : "5982eb37-64ac-4a39-9711-e6c0abbe55dd",
"privilegeSourceId" : "5982eb37-64ac-4a39-9711-e6c0abbe55dd",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"privileges" : {
"io.netfoundry.network" : {
"jwt-connection" : {
"create" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.902221Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Create JWT Connection, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "f6028f6d-ecb9-4bd2-9630-f08bbd630204",
"privilegeSourceId" : "f6028f6d-ecb9-4bd2-9630-f08bbd630204",
"identityId" : "16f645d6-e5ec-4d27-a542-64891f58b3a8",
"privileges" : {
"io.netfoundry.network" : {
"service" : {
"read" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:07.794449Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read Service, All to identity 16f645d6-e5ec-4d27-a542-64891f58b3a8"
}, {
"grantType" : "IdentityResourceAction",
"grantId" : "ac7504b7-d68b-4380-96d4-316d9b0ed61e",
"privilegeSourceId" : "ac7504b7-d68b-4380-96d4-316d9b0ed61e",
"identityId" : "26690eb4-92e9-4ed0-acbe-6e26564eae99",
"privileges" : {
"io.netfoundry.auth" : {
"custom-role-action" : {
"create" : [ [ ] ]
}
}
},
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:10.555444Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Create Custom Role Action, All to identity 26690eb4-92e9-4ed0-acbe-6e26564eae99"
} ]
Super-User Grants
Find Super Users
GET /super-users
Authorization
This endpoint requires read
action on the super-user
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
identityId |
Object |
true |
|
domainId |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].identityId |
String |
true |
Must not be null. |
[].domainId |
String |
true |
|
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/super-users' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJTeXpYZ1pqaVlFNEdiMkgwTGJ5TFVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ1Yjk5YmRiLTlhNTQtNGM3Yi04OGU4LWY3ODBjNTE3ZGUyMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MiwiZXhwIjoxNzU5NDIxMTQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYmU1NmE5MTItMTA1OC00NWIxLWEyYzgtZWQzZmRjNmNjY2MwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Uhd5TFeJwQXpPjF92a-aq0Iq4c6HPYjPRfHwedVJuY6Pby3ropAOmq7tiED3-_up8k5Gc9z4SzI-N_tXN1RSvqGbUqYVZDEQ8evaQTx-B-dZJlwDl6C_WEMwI4SJaGrgF8bgF9l3ZIPcw9dXiUjZddqiiKpXEkaaIY8HZ0p8JqqWpzar6Mejo5JtpabYghZmEJ4W5PB0k9Dk8F1hKLansuq1yq9BWpcGqasc39FLGgHrrB-23KpVnB-p1XNNhGKscerCVk4yYU5RXN15O2pPbnubryDbdC2unaDv-He5fKYizFhvp6aResg7Tz4zTlnSY6kzKB0LKF8hfGQd0M24PQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1568
[ {
"id" : "c8d334e2-65e8-4352-8095-054115256bc4",
"identityId" : "8f04502a-8c14-4074-ac35-be8a8d3b38ed",
"domainId" : null,
"createdBy" : "eed9dcca-2ca4-4b46-a306-8a6f2e1ba498",
"createdAt" : "2025-10-02T15:05:37.643114Z",
"updatedAt" : "2025-10-02T15:05:37.643114Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 8f04502a-8c14-4074-ac35-be8a8d3b38ed"
}, {
"id" : "08a484b2-c912-41a6-b046-8339bdfbc768",
"identityId" : "7a660b7b-f5b6-4f04-a463-7eda71832385",
"domainId" : "1e4f5edd-0187-406a-bed7-925da4850e6f",
"createdBy" : "61725a27-0929-413f-9729-fa98b2f59430",
"createdAt" : "2025-10-02T15:05:42.060580Z",
"updatedAt" : "2025-10-02T15:05:42.094267Z",
"deletedAt" : "2025-10-02T15:05:42.093719Z",
"deletedBy" : "d0df2a8d-77a4-43af-9a6e-bafec4853693",
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain 68 to identity 7a660b7b-f5b6-4f04-a463-7eda71832385"
}, {
"id" : "69433013-785c-4f01-bdb1-21583bea599a",
"identityId" : "49dd56da-e414-43dd-9570-a6e316329cad",
"domainId" : null,
"createdBy" : "e462a442-b34b-4d8f-ae1c-068b991e85c0",
"createdAt" : "2025-10-02T15:05:41.901199Z",
"updatedAt" : "2025-10-02T15:05:41.901199Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 49dd56da-e414-43dd-9570-a6e316329cad"
} ]
Get Super User
GET /super-users/{id}
Authorization
This endpoint requires read
action on the super-user
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
domainId |
String |
true |
|
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/super-users/cc896c79-416e-4ad2-8f35-bade16cfe83d' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJaU3FHdGItZTJkTXo0aEF5bmZsUFZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImUxMGUwMDQ5LTUzOTMtNGQ5ZS04MTFiLTY4MmEzODdiZmY0YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODhlOWFhYmQtMTNhMC00NGI4LWEzOWUtNDhhZTFiMzBjODY1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Ug2OogkchlJBiUKzr2o4WyRf4ZXbydQc0T69iIgAj0uDB2PK8nybi4H1YBcMbpZDakWN-iIuhd7j1NUbBOIE7Tvo58yws6R0lPStTwN7nqo7vK6breA0f0uDg2QwFhuKUYFkZLFhTvwW_yguOu538Tfyp2H4RzqkebP-m3bl7Sr22yb5hSRc0OGxoqBlQ8G8sW72ZrKYESz2U_hV2SgJSve1WVW5sz1o-gAkBmBbebJ0WrWylDrwuYlCt7YIolCQ6yzhhRnSuNRWi3Ui8NLLKyDIPLXCBSw8dVzZ3jbUE4dtsc8IYTHiyXR1kFQGRZMDh4peShH7O_2SlGXJ7LX-_Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "cc896c79-416e-4ad2-8f35-bade16cfe83d",
"identityId" : "49dd56da-e414-43dd-9570-a6e316329cad",
"domainId" : "5ccb4e63-1623-4888-8cc5-2ad7f4045542",
"createdBy" : "88aa647d-2fe7-40d3-becf-0dee25949726",
"createdAt" : "2025-10-02T15:05:23.769154Z",
"updatedAt" : "2025-10-02T15:05:23.769154Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in Test Domain to identity 49dd56da-e414-43dd-9570-a6e316329cad"
}
Create Super User
POST /super-users
Authorization
This endpoint requires the following actions:
-
create
action on thesuper-user
resource type -
read
action on thedomain
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
identityId |
String |
true |
Must not be null. |
domainId |
String |
true |
Client must have |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
domainId |
String |
true |
|
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/super-users' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiItdnJiTTVGWk95YjN2SXBNblFrTnlRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU0NjJhNDQyLWIzNGItNGQ4Zi1hZTFjLTA2OGI5OTFlODVjMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTI5Nzc2ZDEtODBjMC00ZDk3LTgyOGYtNzJiZDBkMDYxY2EzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfSx7XCJpZFwiOlwiZmM0YmFjNjEtMDlkMi00YTY1LTg2MzUtODcwMjYyYjk4ZGZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.snW7Wj1yZKqR02HRpksPfZR6vTrLBqgZlnH78s1eCPv_zwls7DyHE4Gnin_-tDSBgpVBhnk1P3gFruRBvzPAtf7hYa2pHoEqVgWwgVZ8aVTI5mqkSYN1kumSf-_e9r6U8laSeJSEGvzhhK5LgMBLP9DkJhsQ1tzv-0IvyBxBOUnf8yviyCTX1ESR8N31iR5ITVPa8gyP_BcHklI8XLl1ueEPpCUpk8p-Oph1pLj_BBODgX5IM_dIGmvu0_2Cna8G9q5ZIKs4ObduWC36rq37IfSHYhs6hcYI35ARYbzF1Om5ZHrCG4Dx23Ir1GwInMj1ZAOFuRTOD6d5GWKus98feg' \
-d '{"identityId":"49dd56da-e414-43dd-9570-a6e316329cad","domainId":null}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 488
{
"id" : "69433013-785c-4f01-bdb1-21583bea599a",
"identityId" : "49dd56da-e414-43dd-9570-a6e316329cad",
"domainId" : null,
"createdBy" : "e462a442-b34b-4d8f-ae1c-068b991e85c0",
"createdAt" : "2025-10-02T15:05:41.901199Z",
"updatedAt" : "2025-10-02T15:05:41.901199Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.superuser.SuperUser",
"_title" : "Grant All Actions (SU) in All Domains to identity 49dd56da-e414-43dd-9570-a6e316329cad"
}
Delete Super User
DELETE /super-users/{id}
Authorization
This endpoint requires delete
action on the super-user
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/super-users/08a484b2-c912-41a6-b046-8339bdfbc768' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJlb2Z1TE5oOGg4TnM1eDBzaHMwVFNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQwZGYyYThkLTc3YTQtNDNhZi05YTZlLWJhZmVjNDg1MzY5MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MiwiZXhwIjoxNzU5NDIxMTQyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMDFiMTQ3ODYtODZlYS00ODlmLWFhODktOGE0YmVjZjlhZjY3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.b7Z6ALtttPU9TM-KEqBqtLAuiQxOxx-yq1GGZYd_1blnBMbEoOYbblzgxhATvzyfoqKKXYKwblJ99QamlvqqyWrGa2dLqYP-P5PYkYg4XGNJl29bBfcgjcdojD41XY9oJb7dhpYE5516Eo8Y9EWTBo32ScDEpKwv33WOZFt1r3Yh1qYYzEhX5JBAM9TR6Wk5vDbZ72j9ecfZEf3w_mBSaIbAcgAQwC0bPNtRU5T3z1VdbcndtAZpsPH5E-CsLh7xiLuNISe1t1otNe-LkuizlD_j9ePigiFG3G2DHdiCIoA6vrH5k6jdL-Xcm70spPvUEnUSDnog8y1Ii8oa9GEx_w'
Example response
HTTP/1.1 200 OK
Public Grants
Find Public Grants
GET /public-grants
Authorization
This endpoint requires read
action on the public-grant
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
resourceActionId |
Object |
true |
|
isAnonymous |
Boolean |
true |
|
path |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceActionId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].path |
Array[Object] |
true |
Must not be null. |
[].path[].resourceId |
String |
true |
Must not be null. |
[].path[].resourceTypeId |
String |
true |
|
[].anonymous |
Boolean |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ5UkVoVU14dFhEUDBtU09JTzMzaU9BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE2NWQ4Y2QzLTViYmEtNGFiNS1iOGRkLTViYzRhMGJhNWJlNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOSwiZXhwIjoxNzU5NDIxMTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjkzMTY4OTEtNzFhMy00YzRlLTkwZGEtYTIzM2RmNWYxOThjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.H1TMPJvM1H6ZmSuOwshAlhGFLILoqvEAEZSBu32uOXkrS6ZkD-AzSkG_EaQFbs1OP_6lUpJY91ZgMfXt7dKcC6JCI1Bi-JlHw1e1WPSzo8ihkpJTZi_Z2TOUQoXPC4BKCLL-0TZD8cIUzk4EUBiyBFnzmIVXzHHQ6Ss5aJp4FnX33YQGJaGotuEYDakkJjOt2Hh0mN43l2NC4EQUYj9fzUmQmcYyZ_q6vEWdZWHTDZZgb0dhxw9OKNYFwZDs5CEyfCzz_sDCTjOci6mzZhT4FtwobD1uMqJR7H1Fdab2-dD4jxj2kpfqtW3LM_wLB30I73iz0FIJdKJYRWipt6JsYQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1843
[ {
"id" : "6d2b6d90-4869-4cd1-ac4c-4c33e935f4b3",
"resourceActionId" : "9120c25d-c1ab-49c1-a913-ecc9b66fc998",
"createdBy" : "2eb11aac-e507-4d97-a958-8254c89005ea",
"createdAt" : "2025-10-02T15:05:23.792201Z",
"updatedAt" : "2025-10-02T15:05:23.792201Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "638a3cd5-d027-4ead-9565-e3ffb5d54c78",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de"
} ],
"anonymous" : true,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action Test Type on/under Test Type 638a3cd5-d027-4ead-9565-e3ffb5d54c78 to All Clients (including anonymous)"
}, {
"id" : "6d03b0c1-d85b-4c28-acb8-53994c81de3f",
"resourceActionId" : "bf303d60-405f-4fd4-838f-898811b96da3",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:08.047459Z",
"updatedAt" : "2025-10-02T15:05:08.047459Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Read Network Version, All to All Authenticated Clients"
}, {
"id" : "e569c158-ffac-49f5-b613-5d8324f3764c",
"resourceActionId" : "9120c25d-c1ab-49c1-a913-ecc9b66fc998",
"createdBy" : "8cbd0790-4658-4536-9ec5-e9dfbcf930f0",
"createdAt" : "2025-10-02T15:05:39.163752Z",
"updatedAt" : "2025-10-02T15:05:39.163752Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "05191e3e-7f51-4942-903b-289b2b2d4ab2",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action Test Type on/under Test Type 05191e3e-7f51-4942-903b-289b2b2d4ab2 to All Authenticated Clients"
} ]
Get Public Grant
GET /public-grants/{id}
Authorization
This endpoint requires read
action on the public-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
anonymous |
Boolean |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/240da659-fb16-4187-8957-6c3b56a58bdf' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJleVYteTFnQjB4c2ZHNld0MVhlM3NnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEzY2Q5NGQwLTdmOWUtNDRjOS1hMGNiLTVkZTFiNzc2MDU3OCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOCwiZXhwIjoxNzU5NDIxMTM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjk2Yjk1NTgtOGI0MC00MmFkLThmZWMtYzdmM2U3NDkwMjcwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.lEwX6iKK1VBOnI9elp0I-eu5zGtz3jKRwpof7SWK6DZ3Rh1dt6sapjzClCrvao5pk-oVwOzUJFFkDGzmj77IfteJ4XsRG8QOtMlcszvymh145GtnnJNT1V90g9ewmpjb-TyrVfd_C6Vv8gjOL4PO-X2hEGG7kGPauUp7ciEg3Av8CywKQ2QLQpkvVzyqRSOBCUiCt9bWq1pOzkzxdw1sFytXeLM4Vu5FbBJyKCIbJfRXUq2rTeH65jzworumM6APHlg5H3Crhmd08bEc8yVzPrg3ikVQZWq3Ry_ttdippfC7xv4xfFwdCZ09jRLRGqsIhlqhXvWxJh5xwEQd0-ommg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 678
{
"id" : "240da659-fb16-4187-8957-6c3b56a58bdf",
"resourceActionId" : "a42b8955-be66-4280-8d5e-14a73c5b5108",
"createdBy" : "e97d0091-97d2-455e-8ab5-52576586a1b4",
"createdAt" : "2025-10-02T15:05:38.685607Z",
"updatedAt" : "2025-10-02T15:05:38.685607Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "0147a41a-16cc-49fb-8555-6abe9ca6e032",
"resourceTypeId" : "4617b4d5-1ce6-4f22-8786-32c85eeeb5e8"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action 46 Test Type 45 on/under Test Type 45 0147a41a-16cc-49fb-8555-6abe9ca6e032 to All Authenticated Clients"
}
Create Public Grant
POST /public-grants
Authorization
This endpoint requires the following actions:
-
create
action on thepublic-grant
resource type -
read
action on theresource-action
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
resourceActionId |
String |
true |
Client must have |
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
anonymous |
Boolean |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
anonymous |
Boolean |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJCc3BmYlZzQmxVWUxjSmhNYXJxVFFRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhjYmQwNzkwLTQ2NTgtNDUzNi05ZWM1LWU5ZGZiY2Y5MzBmMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOSwiZXhwIjoxNzU5NDIxMTM5LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZTUzZGFkYzAtZmM0NS00N2FmLWE5YmQtNjU4ZmMyM2ZmM2Y0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fSx7XCJpZFwiOlwiOThkODU4MWMtN2NjOC00MDA1LWE5ZGUtMDQ2ZTZlNDhmYWMzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM5fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.g4jXc-vUufwsMiRyA4zEzmkljk01Q6_-Rkm07PQBz66n2kye8WggM7qLcwS2JPRHZe2q5GnpPlT-sTXjBfroXyCsM4-D_bgo9d9CVjAholZB6gkrfUU1uuZPhfNUqXm99FnfIzdXDf973YleqaomJh4F35rJzvmP5kLuc0YBsfclXkPJydH9ZgeixxX51dnrtOyIk_A7_vJGsQv-EV59yuhnuJ-zmdKKwPvP9H_8B7y1oRoczcIRIdudubP_w4TN5na3R1vVXfFMLCytUfYrZDQUZnOCw45VULgmIIj-O6f2wP0lAoP54d2udDZkbOjRPR11PdZOl1SGY2zeAJoyvA' \
-d '{"resourceActionId":"9120c25d-c1ab-49c1-a913-ecc9b66fc998","path":[{"resourceId":"05191e3e-7f51-4942-903b-289b2b2d4ab2","resourceTypeId":"453b0e75-783f-4e7a-908f-e6cdd7a7b6de"}],"anonymous":false}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 669
{
"id" : "e569c158-ffac-49f5-b613-5d8324f3764c",
"resourceActionId" : "9120c25d-c1ab-49c1-a913-ecc9b66fc998",
"createdBy" : "8cbd0790-4658-4536-9ec5-e9dfbcf930f0",
"createdAt" : "2025-10-02T15:05:39.163752Z",
"updatedAt" : "2025-10-02T15:05:39.163752Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "05191e3e-7f51-4942-903b-289b2b2d4ab2",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de"
} ],
"anonymous" : false,
"type" : "io.netfoundry.auth.domainv2.publicgrant.PublicGrant",
"_title" : "Grant Test Action Test Type on/under Test Type 05191e3e-7f51-4942-903b-289b2b2d4ab2 to All Authenticated Clients"
}
Delete Public Grant
DELETE /public-grants/{id}
Authorization
This endpoint requires delete
action on the public-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/public-grants/012a5c52-953b-4ad7-8eea-cb10525311f6' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ3ZUpPdGRtek9pMUM4UlN1b0haOFJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc4OTBiMTA0LWIzYTgtNGMzNy1hYzMyLTRiNDc0ODY2YjhjZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOCwiZXhwIjoxNzU5NDIxMTM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjAxMmE1YzUyLTk1M2ItNGFkNy04ZWVhLWNiMTA1MjUzMTFmNlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGU2NzFjZDUtODM4Ny00NDYwLTgxZjgtZmFjYzJkZjY4NzIyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.mbl9cbgIxSYKXbOINYJaVtn2GCz9KjmVYDtorBrufIy0OgE_ZJ-6Kce7TG3xx0RtRzEUryKpgt3Q2hrG_7ujs8U6T4F3wiuGoZgQzXeX80nWwffoGRY0JOrxl7ceg12_vTlSll7zVLWApCMboHToV5O2l9b_dphs0jzCcEvkKwcRnJC9wq7bgHhSDteBM_Nv_aFtO07Txp8go7kfbRAbVHDroKvVj8C6ejAobfH-AEbPql22LHXf97Trvqp-Dp23EDV2vWBAuf7c7NrrO438N0VbjIHbxWBVymyN1AE67YjZdPe6LwNW5pXDeTCFfdWeJH8Mbgj_uhYFt4EovbFxoA'
Example response
HTTP/1.1 200 OK
Identity - Resource Action Grants
Find Identity Resource Actions
GET /identity-resource-actions
Authorization
This endpoint requires read
action on the identity-resource-action
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
identityId |
Object |
true |
|
resourceActionId |
Object |
true |
|
path |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].identityId |
String |
true |
Must not be null. |
[].resourceActionId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].path |
Array[Object] |
true |
Must not be null. |
[].path[].resourceId |
String |
true |
Must not be null. |
[].path[].resourceTypeId |
String |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/identity-resource-actions' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJMVEVjemVQYm5VN2szMHdZc21MSTNBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImJhZGY5MmFiLTAxZjctNDFhZC1iZmExLTY1ZGM1NWFmZmQwYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOCwiZXhwIjoxNzU5NDIxMTM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzQzNjNmMTAtOWEzZC00Mzk4LTg2MTYtNjM0MzU3MjBjZmJiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.fYyMlJ9BxqYyvn8ECRRW14l0Nl2d6iPMwVfQtpW5UL6wnVWCZ0R16DXNE7jFboz5A3l54ctq9cETcJsknkS0qvZmNKe9KYWkCz_mOL6kH2XWv8ntXjWb4k5lh3Fs2lh8VIXTaKKPAt26d7qboqheJKNZnyfZ086gBx47owXVAcJD514nxs4lVXaAl-C5kbBu6llFFZcNLMD5f-a-8vIfhxJ7viQRPzq8qZt7c0vSwxI9MaIeuybom2cLoL5HP8agrUiwhYhFSa5aNYPvwFJWBKW9fc_ZMXQPobrVetDoEL7VdxgzCGloWvf-Ih3JptK5cW0ZN3xOfvFqILTP1EWlZg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1719
[ {
"id" : "ec8582de-ea81-47fc-9db7-d98f4491f1da",
"identityId" : "e9718556-1495-4bad-a393-101d4a6cd5be",
"resourceActionId" : "da74fb5b-bdcb-47d1-84b0-fc8cfb713cc6",
"createdBy" : "a7dd674d-0e28-4e2d-bd1e-6d6345552c2d",
"createdAt" : "2025-10-02T15:05:34.379346Z",
"updatedAt" : "2025-10-02T15:05:34.379346Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Read Resource Action, All to identity e9718556-1495-4bad-a393-101d4a6cd5be"
}, {
"id" : "c530230b-1c30-49ab-a793-53defb8648e3",
"identityId" : "d6390902-e5f7-4c03-93fc-8788bc6067ab",
"resourceActionId" : "835a8049-4d5c-4e81-9388-078dbbc31001",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:10.702979Z",
"updatedAt" : "2025-10-02T15:05:10.702979Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Update JWT Connection, All to identity d6390902-e5f7-4c03-93fc-8788bc6067ab"
}, {
"id" : "61a5f10d-379b-429d-b3a3-f167c7b8f3f7",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"resourceActionId" : "4e41a0bb-efdc-4e63-a198-141977ab57e4",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.671755Z",
"updatedAt" : "2025-10-02T15:05:09.671755Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Delete Network Host Network Host, All to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
} ]
Get Identity Resource Action
GET /identity-resource-actions/{id}
Authorization
This endpoint requires read
action on the identity-resource-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/identity-resource-actions/8b641583-4afb-4dd2-9577-268cdc77f633' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ2OEpEUWF1Ul9YNzAtN3RoTnZzTkhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImYwMTg0ZjlkLTQ3ZjYtNDgzZS1iNTdkLTdiZWYxYTlmYTM0NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOCwiZXhwIjoxNzU5NDIxMTM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNWZiMzA3YjUtODJhNC00NmU4LWI2NjktOGQ3MjU2MmQyOGNjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ZA3i21fPJNeidt45caP8kSShKmedR-jCfvQGiSmfpyGO4De6U7LF0AwD-Ep14j_Z6fd5he9mA-Pnu-HIxrCFt2Ri9tPbKa5JDYoolmuPDelEUbcnsM-EB5E8e1xQIduKzJF-1HwdV1moINCp9dc8NNHFknbYGXPlr8htSkpWS2Y7iZPtGJKgHEw-3GWRzNDoNmTqUmyeek9iK0ZBZeJZTvdTS_sRK2wpAxwyCdDWl8ZzAX6Z4H9GQ_s2RR44WfZkYo1XfImOnPzCrJEGeQ7jRdTVo0vDzZdKprjYF1C2eGEXwQPPuh4YHLk9fIoifRZ17KyKSjZsvX3i27pAUHGBPA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 754
{
"id" : "8b641583-4afb-4dd2-9577-268cdc77f633",
"identityId" : "d6969bf4-14be-434e-b2b9-2c1917f13895",
"resourceActionId" : "64e8fb3f-8fc7-4ae0-abbc-bd49df6234b0",
"createdBy" : "073bfbed-1f76-4e0b-9971-ec3057715d5a",
"createdAt" : "2025-10-02T15:05:38.419481Z",
"updatedAt" : "2025-10-02T15:05:38.419481Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "eb4cf14f-bc1a-47e4-b61d-b26e3a884b53",
"resourceTypeId" : "ed24b8ef-3616-447e-b6ea-5ff8e5f8efa9"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action 43 Test Type 42 on/under Test Type 42 eb4cf14f-bc1a-47e4-b61d-b26e3a884b53 to identity d6969bf4-14be-434e-b2b9-2c1917f13895"
}
Create Identity Resource Action
POST /identity-resource-actions
Authorization
This endpoint requires the following actions:
-
create
action on theidentity-resource-action
resource type -
read
action on theresource-action
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
identityId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Client must have |
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/identity-resource-actions' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJHVUNLSWNpQ0hOY29aWDNqRmZPNHJ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjAyNjY5ZWI3LWM3MWUtNGJkYi05NDRhLTYzNGU1YjJjZjg0ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOCwiZXhwIjoxNzU5NDIxMTM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODg3M2E4NzUtMDBiMy00ZWNjLThlYzYtYmU5ZGFlOTg0MmY0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM4fSx7XCJpZFwiOlwiYTViZmE0NmUtZWUzZS00YWY1LWJiNmYtYzFiMzZjNTc4YWFiXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.XR_B5cn0wNIcndsDptBjce8XQ5IT7b_HDsyGXqznjOci864JgAPUlRhjM0t4ebpEGqrRD8fmbDP3VbBLJ94AokcM3yVJQpQ1Uy8zwuTikA3qkhp5Asv0zdx9pZGir5k6XGSA72C9jeXdrfOriyv4V3uKcSkRPssAcdIu5tUMa2PGQjLoringANKVICI5lNn1ULki5lJAAsx_9GqUF8g9WVjYtrbinx6SMt0y-Na5Aa7zYDQ1E-xU5x0D27H6NDc7TednCM2RZ84eVhiUVlriEqlMOSh6kOsVtG_IgcFTmVBvSA-ELhgfSE2G9kNyVm0V61OvBqUtoUbDeUTiDCNgsA' \
-d '{"identityId":"2ce1524e-7508-471c-be9c-8a1a10ada2ac","resourceActionId":"9120c25d-c1ab-49c1-a913-ecc9b66fc998","path":[{"resourceId":"f3570589-0ac7-4337-8d15-bf3a1e7629e0","resourceTypeId":"453b0e75-783f-4e7a-908f-e6cdd7a7b6de"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 745
{
"id" : "82a6c34b-dd70-47ee-832d-b4f1f6853e42",
"identityId" : "2ce1524e-7508-471c-be9c-8a1a10ada2ac",
"resourceActionId" : "9120c25d-c1ab-49c1-a913-ecc9b66fc998",
"createdBy" : "02669eb7-c71e-4bdb-944a-634e5b2cf84d",
"createdAt" : "2025-10-02T15:05:38.561942Z",
"updatedAt" : "2025-10-02T15:05:38.561942Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f3570589-0ac7-4337-8d15-bf3a1e7629e0",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de"
} ],
"type" : "io.netfoundry.auth.domainv2.identityresourceaction.IdentityResourceAction",
"_title" : "Grant Test Action Test Type on/under Test Type f3570589-0ac7-4337-8d15-bf3a1e7629e0 to identity 2ce1524e-7508-471c-be9c-8a1a10ada2ac"
}
Delete Identity Resource Action
DELETE /identity-resource-actions/{id}
Authorization
This endpoint requires delete
action on the identity-resource-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/identity-resource-actions/057eac4a-d552-41ed-9a25-6a8c44ae49bf' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJXNG1ITmZmdXJQVER4VlNFNllFbkV3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE1ZDAxMzZkLWYxYmYtNDg0Yy1hNjYwLTBlNTdmNWMwZjk5YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzOCwiZXhwIjoxNzU5NDIxMTM4LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOWJkNTZkN2MtNDJkMi00MTgyLWJiMWItMzhlZWQwNTExYTlhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM4fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.CqNOqB-0LEABVHUVtH1PsO3B8wDuj3twVQfG_wE8noztMysRTm980m88vDaJUx6-SAlZxvIFatTQ7sYvFV9pQW4fD8UKVYqQ7p2A2a2mqBkW6FF9CltAjRzbtjrGe0hlIk5-5us3uFINrYB7SZyyaTahT8ilo96fOu-UOu2HcbYNbhFeJ04Fqr5Kv8DQDwUaTG1B7o5s8IY9oxs6sZqASGtiGo-Hj9Taapg8ypud41tco_yas_ckO1hfL5PBoXXqkg1QhnMyoM36Rg_FCx4H9on_QUdH7hHA0Dmcq8Z3tLeWuFv4-4HJQdHok3vKICMBcgTlEOPddt89-5RNxOqWhg'
Example response
HTTP/1.1 200 OK
Custom Roles
Find Custom Roles
GET /custom-roles
Authorization
This endpoint requires read
action on the custom-role
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
identityId |
Object |
true |
|
resourceActionId |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].name |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiIwV3VPcHlmcFEtaFdOeV9QMHVobm9RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI3MmRlMWU4LWU4OWQtNDJmNi1iYzk5LWVjMzgzOTkxMDVlMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNSwiZXhwIjoxNzU5NDIxMTM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNjJkYjJkZjctNjk0Yi00MGIxLWI5MDItYzAwMDQwMjE5NTQ5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Dfo85mb463GY-4vX89guixuXbwggr_o1W8qd1qJqi5vX7kpE-83Itw8vkm_Cq6NzaLQHnMnujCLNUeCUeZG1G5hXKhoX8umHGTmM4cY8qnXOsyG5huDWdd8yoSSXciXc0iEbCQPQPgJkKvdTW7gXgux-WWoyXvbyE-EaBeY2TS2tyCoiBE1CnC86-DmoLAPJywT1Cz9kiEuPbvERcjA6xLt9s4RAJGQm2-yfrWSUr_dCC1O1uEFZvR_t9bfbZKb1fhLr9U97GZQ6GrIBQMdOfLBdRy3LjkHoLaKGArEycdbEAvz5vqo0upjF0ZYNLvuE30qq1MIXDTSmWsLJJEll6Q'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1161
[ {
"id" : "c88f10f2-61d2-458e-a156-7bf270fc31d4",
"name" : "Customer Signup",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:10.460985Z",
"updatedAt" : "2025-10-02T15:05:10.460985Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Customer Signup"
}, {
"id" : "668720a0-531a-44fc-b196-4d3dbfba73eb",
"name" : "NF Billing Admin (ALL Accounts)",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:08.902084Z",
"updatedAt" : "2025-10-02T15:05:08.902084Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "NF Billing Admin (ALL Accounts)"
}, {
"id" : "f100e7d3-84d8-4c17-a6ad-9c68d6a25536",
"name" : "Test Custom Role 23",
"createdBy" : "c5377e9e-0819-4fcb-8275-5646ec38fe0b",
"createdAt" : "2025-10-02T15:05:35.225818Z",
"updatedAt" : "2025-10-02T15:05:35.225818Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role 23"
} ]
Get Custom Role
GET /custom-roles/{id}
Authorization
This endpoint requires read
action on the custom-role
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles/d1abab1a-9d49-4b62-b326-0d0245187055' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJydFZSalRVY1RObTlfalBsYm95akp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg0MDUxMjMzLTljZDctNGEyZC1hNDcwLTNjZWFiMzE0NTExNyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNSwiZXhwIjoxNzU5NDIxMTM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDBiNDdjNzQtYTQ5NC00NzI0LWIzNTItMTQzNGZlZDliMjM3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.Xpgw1O0qtZJukExJcATFiXy8I0jfniCvoIV7F0XaYeCdqttSYfXk4Ue7vmQNgYYx_5i7HfVnDyuqEFbdAanWLtt1kKnjagEZc7j8a-NkmJFbIrm9-qmC-UxupGuaSpLb3XQpFei_A9WjYlhy55G9HBWn6TF6HBgFQgK-JHSsmHdCYk9f_w377_CFgQwMQtP80przP7M7KIw1VS70inESwFh-J4MrBz7XeKixTFEVz8Dq1N_Vf5jyj_uO2iumk937IMqy67xeg-pQDRc1zD7EOVCztdfELM3yWAVMYBmezV5uPtZShi3BfOEt28hjAvtiSVkprIMwCkJN6Oigr4o83g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 379
{
"id" : "d1abab1a-9d49-4b62-b326-0d0245187055",
"name" : "Test Custom Role 31",
"createdBy" : "e27f2f32-1e01-4695-93af-9d981732aacd",
"createdAt" : "2025-10-02T15:05:35.806166Z",
"updatedAt" : "2025-10-02T15:05:35.806166Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role 31"
}
Create Custom Role
POST /custom-roles
Authorization
This endpoint requires create
action on the custom-role
resource type.
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
name |
String |
true |
Must not be null. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
name |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiIxSnMza3FLdFdUMmV4UjVuSkJ0SGd3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijc4ZTFkNjNhLWE4OGUtNDBkMy1iOGEwLTdkNjVjNzY4OTIzMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjBjOTgwZTQtNGUwMy00NjJkLWJiNTgtZGJhMWZhNDkyNmVkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.RRjISu4fA67rL9FRR6o5VXsNEsdEWOH0cYDwNDhmpefpnt9mF5_3Zajp1IjUhrGKU-FctIaDzoLPkf2QcOSzrVs3eLg2tEZx9VhPsAUt4z5ju_RwhLvQCIXWWSI6B7WWJzss574bMyVru0m4QKwmCGItLuFG6EAX08a2VBwyXffKnCjID7HRKcH0qmzEGoK_8OU3DYYVUp8KFDwFA5v_6Zt8g4ErpvjlMx468E8Jgwb2gG4L0CObwCd_i_KzJK90AHKzazQVNE7fppq08peMkV5kc3bIt9hDPjyJVFgCV5XUeaDda9sClSRJvyrXIxY6ijdFFmc7ozakh6cgpHnc0g' \
-d '{"name":"Test Custom Role Create"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 387
{
"id" : "15153e66-dabf-49b5-9da1-06fbd1c27604",
"name" : "Test Custom Role Create",
"createdBy" : "78e1d63a-a88e-40d3-b8a0-7d65c7689230",
"createdAt" : "2025-10-02T15:05:36.197741Z",
"updatedAt" : "2025-10-02T15:05:36.197741Z",
"deletedAt" : null,
"deletedBy" : null,
"type" : "io.netfoundry.auth.domainv2.customrole.CustomRole",
"_title" : "Test Custom Role Create"
}
Delete Custom Role
DELETE /custom-roles/{id}
Authorization
This endpoint requires delete
action on the custom-role
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles/eac463eb-b56d-4ddc-bfd7-23218e304269' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJPb1NxbkRpWWtSN090V2ZLRHA5bFJBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjlmYThiNWEwLTQ4NGUtNDY4My1hOTYwLWFkMTcyY2JlOWRkNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZjk5NzMxM2ItMDhlZC00ZGNmLWE2YzAtNDUxZTQwYTY5NDRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.U-t7Gh3dvCzFnRc2_ktiFE08QCpiuf94Dzb5eAFCuTPu0BhQSymqQ6o5Ri6PyANgwnTFT_gIZ_JgHBI8HEUpqCGL4ndjsvAsex3i6aGaPXxrDYcEcVjnqGbKM1o06GYV8yyYvfItHe-gEeRTOc3UJo7lhEVQifxkF6HQp1l6D_K1eEX4Icq85Ypiy4aSeffKqkaMMVLuWum8CTnj4HiYciXxq6HXxsI9beYw7rwUVP0h_IrW4KLjP6Gc1Qft2qsKbIRpN95J_a9NqIg7IVyvL1rP8nXxbL9VRo6OmKTERGJJKYM33RS8TLvXt-21Ga8085Do3dxEpYmAlIbNSB1OXA'
Example response
HTTP/1.1 200 OK
Grant Custom Role (deprecated)
POST /custom-roles/{id}/identity-grants/{identityId}
Deprecated.
Authorization
This endpoint requires the following actions:
-
read
action on thecustom-role
resource type -
create
action on thecustom-role-grant
resource type
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
identityId |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles/d5d50375-6d33-4654-90eb-e9201d3957b8/identity-grants/c083e2e2-73ab-4614-82c5-b62d4809934e' -i -X POST \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJXelRfNk1ZVzlEUGJYbXhVTGU2WUNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk1MjI2Y2Q1LTUzNzQtNDdjYy1hNWZiLTAzMDlmZTNjOTVjNiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiY2Y0MWQ0YzEtMmMwYS00N2I1LTkwYjEtNjQ5ZGU2MzEzYzY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fSx7XCJpZFwiOlwiN2EyZjFkZDQtMjY3Ni00MmM2LTk5YjctMWMxYjVmZTkzY2VjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.xIZlvTokUrZ2kjc-a7DbDxKDEO1_M5QcWyrFL13YbUZgDxBMV2Yf3WInxc1udiKYCKFFg9TYsVrgbWx1913IsRk3OtiMeA6iSW-oPc053GBK-BAkaovxxb09zprvlJUgVRl7L3UP8Lr3mmUpI6cYVh-1Qa6CdFdxPxkU_eo_lH8vdcOQFZJ_b6IUs8qr-4Vs15AMHyEzaBIzzn4YT6itWNeW7BDcbUqqtU5ujLDIMaUaWKXn42tZxGDunAEZREo8ZY4F1bRmk_OxEEl5cV12vikOkB_LY7aD3HTB2oSGP6ySf8mBCZZ8m5F1ug3yVROHo09c2lg25upP8BUe3TVOUw'
Example response
HTTP/1.1 200 OK
Revoke Custom Role (deprecated)
DELETE /custom-roles/{id}/identity-grants/{identityId}
Deprecated.
Authorization
This endpoint requires the following actions:
-
read
action on thecustom-role
resource type -
delete
action on thecustom-role-grant
resource type
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
|
identityId |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-roles/738dc92b-1f2e-4e14-baeb-50f650cecb41/identity-grants/5783f9b2-6730-4e90-84b0-aa17284c5d0f' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiIwXzJ1MW9QRkVlTm1ERVptT3VjYVBRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA0Y2RkMzFmLTRjZWMtNDIyMy04YTRmLWI1NzVhNGRiMDQ0NSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiODA4MjVhNTctYmE2Yy00ZmRkLTk5YzUtYTJkMTEwOGFiNWZmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fSx7XCJpZFwiOlwiMTk0OWI2OGUtYjBjYy00YjhjLWIzNjgtYWI2YmM5Yjk1ZmY3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.WOEDJx3r5uENnNje4zmiIl4p3gq7Inp0lCzWUjebaqeC8FrUKs9i5bQ_9U7wAeJ2qdMndnC2IVoM7FRC-oRF5JUUgr7XNiP0087WxyjygjH4ihhw84jZBBD6zbxipirmFJKD0fIQw9YZhk5d1_6x-_O10my9JZjAD97S7rEHj3FpOlpS0o0TlmWFRazXygSaUbu7V9jJLiWbnUU4boP4Acf5DcrvjjW5zoC-oXo2WQ94PMoI1zxA8jPM8wUWZF0SZkNhlR_1O5KVZ5q9c9THIC4xg98DMQ7BJbPdIkm4fkr-9SEmJC-6Pm_1UuxsABhQmQtcD6J70ZpR-H4-D2t_lQ'
Example response
HTTP/1.1 200 OK
Custom Role Actions
Find Custom Role Actions
GET /custom-role-actions
Authorization
This endpoint requires read
action on the custom-role-action
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
customRoleId |
Object |
true |
|
resourceActionId |
Object |
true |
|
path |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].customRoleId |
String |
true |
Must not be null. |
[].resourceActionId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].path |
Array[Object] |
true |
Must not be null. |
[].path[].resourceId |
String |
true |
Must not be null. |
[].path[].resourceTypeId |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-actions' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ2SUhnT0gxZHVCa05XektUbzAtaW5RIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjUwMmY2ZDAwLWQ1YjYtNGU1My1iNmNiLTE5ZTk5NzJlN2NmZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNSwiZXhwIjoxNzU5NDIxMTM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDM3ZDFiZDQtMDNhNC00ZmMxLTkzYjctYjExNGU4ZmJkYzMyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.JCB--_61kVWlKbTaObYq1OX9RBOFCjo-drRYtgyFAiqrtf5xdK_R2ZNYaG9mhRJUC12Xm8HOJtcz7wU_DKYXCM2nohu8HkEEwl1AIzWynSULJdvN0vJXQM0UMhOvI2wNB-eb7uqo9Epxxl67SqbEi7lplKlZNyuFssEnZRVKuts2E_AlCP-gg9cC1qfAcDBEuAgHiVX0YWu-_Eo-Y6c2bhZJ1GVSd1lau4p8lzX9vDGFUrTffQ7Ku1bvhqyjO9HlskyfR67XNK_q4qVqcywVoAbyOAyPOSRG-Ph2uSdL0itUKnsDZoIv85KY2OKZE8OAXgINn7BoD7ZSChdx_wOX7w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1281
[ {
"id" : "f9be87d4-40d4-4f89-badf-ef8e39713a5c",
"customRoleId" : "665bf926-a4de-4a65-a59e-1206e0ff6fcb",
"resourceActionId" : "490c7fcf-ddae-4f8e-9d85-35193854e79c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.851352Z",
"updatedAt" : "2025-10-02T15:05:09.851352Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Browzer App, All"
}, {
"id" : "1781fef5-7053-4742-9644-cf30a325e9ed",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "ced536e2-98db-43c5-a628-5c66a22ab78d",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.879240Z",
"updatedAt" : "2025-10-02T15:05:09.879240Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Read Root Certificate, All"
}, {
"id" : "ee1b42e3-5ac8-4afb-8cd5-6363d7f6b966",
"customRoleId" : "97315ed6-2fc7-4a40-b7ea-abe53cc6a188",
"resourceActionId" : "02e61754-3ac9-49e5-8ec0-fa78f59ad5f3",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:10.189190Z",
"updatedAt" : "2025-10-02T15:05:10.189190Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ ],
"_title" : "Update Resume Network, All"
} ]
Get Custom Role Action
GET /custom-role-actions/{id}
Authorization
This endpoint requires read
action on the custom-role-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
customRoleId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-actions/1dbb7d53-06cc-4641-b1c0-8d8fcfc44aaf' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJlTmRsMzdJSzVWbHBjQ2k5cE51THR3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg0ZWQ2MTQ3LTA3ZWYtNGFjNy1hMzYwLWE4YzI4ZTg4Y2RiNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNSwiZXhwIjoxNzU5NDIxMTM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMGExYTg4NTItMjc0ZS00YWJlLWIxZTAtMDcwZmY5NDZmMjkxXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.vkX_XQhWMyDNZOZkjwY-NBAHcR5--ejFg0ygy5u6LcbuHv7jYTdVnEvQbPYLT6Plt-MOZVSwKN7YdfEbrCOwKORuzCHeNpYQ1aMwzwWOs9eAyDpgHxnEJNPH_rUbntxHQv9hv9iyAYJJJ-np-DSzIDLBBWHGKW1a0oEH66DduBs6BLJNeLfT1pTIhQOGXl3gVdcKG4OFXjJ6mQ5weu0WDP6OC5olsSoJNTqPhkx1flagKx1gd69IKg_hyzpdZtPB8G8GeRg_wJvem_yn-CL_sMeTv9rux6aUins1vqNliXPZfE8undL_6Sur1I9JoSM0bzTodq9gsVEEYAVt0_NUpA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 613
{
"id" : "1dbb7d53-06cc-4641-b1c0-8d8fcfc44aaf",
"customRoleId" : "f100e7d3-84d8-4c17-a6ad-9c68d6a25536",
"resourceActionId" : "35659fcd-8fa3-44eb-9455-2f2f79d9145d",
"createdBy" : "49d17d94-da04-4f0c-9f57-3fc42a84538c",
"createdAt" : "2025-10-02T15:05:35.268505Z",
"updatedAt" : "2025-10-02T15:05:35.268505Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "2dc1ba43-c37a-4f6e-80c5-df98c61c8161",
"resourceTypeId" : "60c86725-b02f-4bcd-ae37-79f1ae64ef51"
} ],
"_title" : "Test Action 26 Test Type 25 on/under Test Type 25 2dc1ba43-c37a-4f6e-80c5-df98c61c8161"
}
Create Custom Role Action
POST /custom-role-actions
Authorization
This endpoint requires the following actions:
-
create
action on thecustom-role-action
resource type -
read
action on thecustom-role
resource type -
read
action on theresource-action
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
customRoleId |
String |
true |
Client must have |
resourceActionId |
String |
true |
Client must have |
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
customRoleId |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-actions' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJmWXJmeWxNMmpRY2VXZTNaOURjcmJnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImZjZjhhMDk1LTZhYTUtNDRjMS05NzMxLTBjMjY1ZGFkMGYzYiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNCwiZXhwIjoxNzU5NDIxMTM0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjQxMmJlZmEtMmQ3OS00NmNjLWE1NTYtYjNkZTMzNjQ5YTVjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM0fSx7XCJpZFwiOlwiZTNkMWEyZWYtYzhlNi00NjJjLWJjOGYtMmM3ZTc4NzZmYjU4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM0fSx7XCJpZFwiOlwiNjU4M2JlOTItNzE3Yy00MjNhLTlmM2YtNTBjNDU4NzY0YzBlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ED7TOuYfQItw3hBNjh5zHLAhtLeEwg3quC7A5Is9JG-h82yAI_cAfqWi1Lp9pI05I9XW6drlLSpJWKfyrKb2KGcOqMDfDejrCNlTmeqbcRV3Yb8KlAO1j52CCCFYvYNCAQ6lICaEewrGMgJh1UHwOLkMchB7VYZGmIgaMK3NMw4UUVSnWCFmDOrnoZpl7a5dNjUvf8mTWGIlSHH1WDIfDsippASHal5MRwIP9o58PHNK8KwYlu64BSpAQZjOeKeFrU_Rd3v86_HkEzhTG49E_LC96YsnKcmqDx6-K0nU_CF_31fpnW0iUE_yI2Gu5JJrSpUrNnAX8sj0TXX24jU5SQ' \
-d '{"customRoleId":"82138ec1-045f-4ce7-aebb-571891b2b422","resourceActionId":"9120c25d-c1ab-49c1-a913-ecc9b66fc998","path":[{"resourceId":"7795b5e2-bbe8-419f-91b7-4e09f0e0748d","resourceTypeId":"453b0e75-783f-4e7a-908f-e6cdd7a7b6de"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 604
{
"id" : "def301f7-3a71-4743-b078-503e33b67ee8",
"customRoleId" : "82138ec1-045f-4ce7-aebb-571891b2b422",
"resourceActionId" : "9120c25d-c1ab-49c1-a913-ecc9b66fc998",
"createdBy" : "fcf8a095-6aa5-44c1-9731-0c265dad0f3b",
"createdAt" : "2025-10-02T15:05:35.040513Z",
"updatedAt" : "2025-10-02T15:05:35.040513Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "7795b5e2-bbe8-419f-91b7-4e09f0e0748d",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de"
} ],
"_title" : "Test Action Test Type on/under Test Type 7795b5e2-bbe8-419f-91b7-4e09f0e0748d"
}
Delete Custom Role Action
DELETE /custom-role-actions/{id}
Authorization
This endpoint requires delete
action on the custom-role-action
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-actions/4e868d61-0558-4ac4-8b73-7d5475e64946' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ2bXdpbGtxcFdIZENJb1lVMGppTkhRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImE2NGZhZjQwLTEyZmMtNGIxMy05NjVlLTUyNzNhZWQ3Y2JkMSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNSwiZXhwIjoxNzU5NDIxMTM1LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2EwMmY3NTgtMDA5Yy00ZTEyLTkyYzYtMWRiMjZkOGZjYjZjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM1fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.tx3NUObE1oOe91LTGu2UTN-SmUMk57WyOOlnCPJmOCgw7cvhw2FHaYze9BciaRnHGE4_K3wGvLKy6CMb7buf96zCwB1VX5U2TM2sM22dj_1sQ4FOWy5kQDKn3uaGEhGWiQdI8IpTYGycl-SJKYBvMIqizlkDjxtbrzRBMJnuRQEsmGroyjIZom-Bq3HfRbxKF5Wk7ZAoIsRuPKqUnv4RySQ8Ql1-BpKqhnXsLRB-NCbvudwUGkn4Aui99kbhGgv_6scuWHWWbEWQNsBMeNQT44Iut8st3EAvkDg-uLd2iNdcqjpb1iDuv9ObBXtaN0QTwk9snrxoF7tkMU72LhOMgA'
Example response
HTTP/1.1 200 OK
Custom Roles Grants
Find Custom Role Grants
GET /custom-role-grants
Authorization
This endpoint requires read
action on the custom-role-grant
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
customRoleId |
Object |
true |
|
customRoleIds |
Object |
true |
Deprecated.. |
identityId |
Object |
true |
|
identityIds |
Object |
true |
Deprecated.. |
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].identityId |
String |
true |
Must not be null. |
[].customRoleId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-grants' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJDanFoMEc0WU11OUk5ZUNnNW9iMEx3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImM0YmFmMjdlLWQxMzctNDZkMy1hNDUxLTE4MDczMTJjYjliNSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMTRhNjljMDQtY2M3My00YzZhLWI3ZGUtMzE1NGU5MzFlNmRmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f512zfatrn99nPUV_8kT_ymGA3g8mwa_9mZXRLIr0uC8Q8w8NFKmV5gFq07wsJNXyCYmBPyZReDP9tpDAsH6VMNisRWGtpAMd-MswCNcblYfnm6bCRO_2neveuk9jpaH47J9Fb5VuiNC0x2oDkCr-mEoin5Dg-onUSWTeO3yAgx-x4Mnaz2Nbqp_X89nj6s-VMnxsHj-Uut1fUoJihmM_AnRfJrpB8OrkqBNuzEIopXaQzbVjpUw4ViT_fZv-RuQsDamv3xyMT2rrK4eibnzDayk_LUK3j6klIeTKlUtbrEa_Y8OXoe_ZZ-pqf4wI_iWcPjOxVjluXXJdHOi5WtxIQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1415
[ {
"id" : "8ae2339f-5b89-4e65-8bd2-ed2689df5a18",
"identityId" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:06.805843Z",
"updatedAt" : "2025-10-02T15:05:06.805843Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 0ab1b47d-a5de-4f39-a3bd-7b130cacf401"
}, {
"id" : "cc53d1aa-9a61-424e-991b-35e11f8f2643",
"identityId" : "83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:07.075079Z",
"updatedAt" : "2025-10-02T15:05:07.075079Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity 83d8cce9-1ad2-4ec1-ae23-9d1f3d28f2ba"
}, {
"id" : "ac55b63c-7963-4b42-a3ff-dc2ebae98c3b",
"identityId" : "d6390902-e5f7-4c03-93fc-8788bc6067ab",
"customRoleId" : "233ae92e-4b5d-4cab-9549-5d55fd1cbf6c",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:10.602282Z",
"updatedAt" : "2025-10-02T15:05:10.602282Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Read-Only, ALL Auth Domain Resources to identity d6390902-e5f7-4c03-93fc-8788bc6067ab"
} ]
Get Custom Role Grant
GET /custom-role-grants/{id}
Authorization
This endpoint requires read
action on the custom-role-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
customRoleId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-grants/0e480462-7835-437c-aac6-00c50fbf0abe' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJiTG5Dc1BQNmdZbVV6b1FzSW5tWF9nIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjNiNzVhNjAwLTk1NjgtNDY3OS1iMDMyLWFkZjAzYjU3MWUzOCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDg0ZGE4YWUtYjNkNi00NDI2LTk4ZTktOTBjY2MzNjdmNDdlXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.kAuPKls_jhpO8JgGj5ykjsDv-PM6-P_LQfdL9_4eb8ce1QxxclwMPyt2HSfiKH_EvBq1IqRovisERhGgE5skUoIho_9-y44gPpsQjJzDllst-CX5cN5DYJkRoxuZjyHvhvuIxV7Jp-9MJANjR3LC5Gy8IK6sG8O2aELdBFBWb7TInQCucFD2XebI-ZslqrUH8_5lEaNs6kvYR86YJ4XrY5ed86Whi89zPI0kvsx5qjosDhkInmD7Irr1eWvIzol9rFWrCh9QCQUT9j2fVooYdRkI1DVMtMCgjA3uZh16x3n8flIXK9z6JYXG3uB2k36w6xqTOisVCF0X5xZfq24D1g'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "0e480462-7835-437c-aac6-00c50fbf0abe",
"identityId" : "037cc483-0c47-4235-a0f9-e4415c16aeb0",
"customRoleId" : "5846f245-3e1e-4b7e-83fa-4b0d3a840a82",
"createdBy" : "c2eab267-c723-4925-ba69-5c103ed2d2a6",
"createdAt" : "2025-10-02T15:05:36.514263Z",
"updatedAt" : "2025-10-02T15:05:36.514263Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 35 to identity 037cc483-0c47-4235-a0f9-e4415c16aeb0"
}
Create Custom Role Grant
POST /custom-role-grants
Authorization
This endpoint requires the following actions:
-
create
action on thecustom-role-grant
resource type -
read
action on thecustom-role
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
customRoleId |
String |
true |
Client must have |
identityId |
String |
true |
Must not be null. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
customRoleId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-grants' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiIxcWRXRlNsdmhnMkxETkhpWVNsYXZnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA3NTllZDAwLTExNmYtNDRhZS1iZDFkLTMxMWJmYWMzYjQzZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjkzNDFkYTctMWU5Yi00NDg4LThkOTktOGNkNDE5MTAxZjE3XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fSx7XCJpZFwiOlwiNDBmNjk5YjItOTJhZC00ZDYxLThkZjAtZjI5NzRhZTZmNGFmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.S9x20TdQrXrKRMg1tHrxUEXgmy0btf0fnGcsJR8XCXoVqE98X1H6bwXHtliXd7AWXC1m5xHvk9K6s9o7m3hKwas6eRBB0LgdaoiIQ9LJwu3S_uQk9RjGuHnvZifYmkLeANOlByftnHzzEGpAv4XawBwxi_lkGaL8hAFDZzGczXzFZitc8LidF8jKW8Vjf0HXBoDQojEjgbgOYcvl09_SX7Cs2YHm3Exa1aTGElkQSEP8sJv3NeOAzKadPPlQTwv2TBiA_80fDCjhJ3NZvE3rTBd0YACKcu-UUtpPfEiH96Gjs0-FZ8wifbYm4y7IKnnjdFMskTDBd1BDoEy7UE6dqA' \
-d '{"customRoleId":"6274e432-1e1b-4d14-b631-cc26f7b38741","identityId":"34ae2df8-cc22-465a-8cba-012e36835792"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 452
{
"id" : "d5016482-6199-4412-8836-c35f18a2fb64",
"identityId" : "34ae2df8-cc22-465a-8cba-012e36835792",
"customRoleId" : "6274e432-1e1b-4d14-b631-cc26f7b38741",
"createdBy" : "0759ed00-116f-44ae-bd1d-311bfac3b43f",
"createdAt" : "2025-10-02T15:05:36.827183Z",
"updatedAt" : "2025-10-02T15:05:36.827183Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Custom Role 37 to identity 34ae2df8-cc22-465a-8cba-012e36835792"
}
Delete Custom Role Grant
DELETE /custom-role-grants/{id}
Authorization
This endpoint requires delete
action on the custom-role-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/custom-role-grants/98d43357-1d59-4871-9762-078b615c163d' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJuYlRvV1ItMTdkQXhCTW9hUVRldHp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjYyODZmMDQ5LWZjNTMtNDZmNy04NmJiLTgzZjM2ODQ1YTYyNCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNiwiZXhwIjoxNzU5NDIxMTM2LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjU4YjM4YmMtMDkzNi00OWQ3LWFlYTYtZDQ2MzVlZGJjMjk5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM2fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.TZ2v6KSZJwBbhm_WupGHdjSP1I4zkVNKr95TvX8rU5eqNPWCS1L-tOjO-l5CPXEdO9CW2CqJMSPgxoy84NuJk1-MW-Pz6kOjts99qI_G1qJlP2pkQfnY6vyPCMR0wYOZIxW_s-6suoekWDiW-thmC9ee4xcqaLQM8ucdvKt_gEI243i4Y-O82xayCEPmBIQEh0MLpahxFFg8GAsEmFxkkM2NhdTtyEFefd5SMvIPZIgOHczRgj5FRXEE3OVRYMl8XSJnqOoTBEhpC0d34dZxzo9N9HTD1yE_DaLSHDl2VHx273D9ibEJpk0bgLY9cLK8vPXLugFHefbSeXf2MYISsg'
Example response
HTTP/1.1 200 OK
Standard Roles
Find Standard Roles
GET /standard-roles
Authorization
This endpoint requires read
action on the standard-role
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
standardRoleTypeId |
Object |
true |
|
identityId |
Object |
true |
|
resourceId |
Object |
true |
|
path |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].standardRoleTypeId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[].path |
Array[Object] |
true |
Must not be null. |
[].path[].resourceId |
String |
true |
Must not be null. |
[].path[].resourceTypeId |
String |
true |
|
[].type |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-roles' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJCQ0hybEVsOGNLeURtWEJqeVUzRVZ3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImEwNTFjNzRlLWExMzEtNGIwYy05YWIyLTViYzc0YzQ2ZWYyMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MCwiZXhwIjoxNzU5NDIxMTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjlmNWRmZGItMTU0NS00NmQzLWJkMDUtMTJjODg2ZGNjMmEyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.uxM2JA_orLlTY5AG-2nspDbOdPHbC3VmOumr7nN0diE1aWJifE7Qa-7I1YC_HWiLFw2H8_L1BDuBwsstDHHFiwMRdhjVtpvYP626yEZRMvII-uSrhsvG9v7oqNMsGW-c0o8tZOFiNe2DRVoSSKtjilb8_Y09XjHzbQREqHaVI-cuVbECO10OESKAzfWeN2oPdIF2nlsY5S4g1M4rQ9BMFK5NNfvyhioreP8rBr5NK61UABpaoXVAOQu9Dvrar-WehJHKo4PfME0qAxg4LvWEwKCNCrutgprL26d15ClH8qO2U_reLfe-eLPnFgB_quF_iklat3v9FVBThTPlW782yQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 2051
[ {
"id" : "0460b468-443e-4a2d-a15c-53d316d56c10",
"standardRoleTypeId" : "b38efc50-cca0-43c9-8ed4-8afa11ede23a",
"createdBy" : "c053b18d-f8e1-42cb-a5e7-edadf075b52d",
"createdAt" : "2025-10-02T15:05:40.539917Z",
"updatedAt" : "2025-10-02T15:05:40.539917Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f384c4fe-16b3-48de-b017-25c0dfa82026",
"resourceTypeId" : "54138c10-8a9f-4b5e-871d-2e203e9582aa"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - f384c4fe-16b3-48de-b017-25c0dfa82026"
}, {
"id" : "ddd39147-0ce2-473d-93c7-25b1b404433d",
"standardRoleTypeId" : "46b9d14c-2b73-4854-812d-fde4e3fba1a1",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:09.935417Z",
"updatedAt" : "2025-10-02T15:05:09.935417Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "97abf663-9647-4bd1-8dc3-a1f63f6f040b",
"resourceTypeId" : "08d06c1d-667f-428a-9e59-1dfd25c4292d"
}, {
"resourceId" : "cf53e966-a3ad-4e80-a5fc-380fe8d48e57",
"resourceTypeId" : "9c645b45-9079-4d0c-862f-9001a555f58c"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Standard Role Admin - cf53e966-a3ad-4e80-a5fc-380fe8d48e57"
}, {
"id" : "2854b8f9-6538-11ea-98de-128b2daaf7e4",
"standardRoleTypeId" : "46b9d14c-2b73-4854-812d-fde4e3fba1a1",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:10.067423Z",
"updatedAt" : "2025-10-02T15:05:10.067423Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "97abf663-9647-4bd1-8dc3-a1f63f6f040b",
"resourceTypeId" : "08d06c1d-667f-428a-9e59-1dfd25c4292d"
}, {
"resourceId" : "b75be358-a3f9-40a5-972d-a804c4758041",
"resourceTypeId" : "9c645b45-9079-4d0c-862f-9001a555f58c"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Standard Role Admin - b75be358-a3f9-40a5-972d-a804c4758041"
} ]
Get Standard Role
GET /standard-roles/{id}
Authorization
This endpoint requires read
action on the standard-role
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
standardRoleTypeId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-roles/0460b468-443e-4a2d-a15c-53d316d56c10' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiI3S0pxdGdqYTBkYkdOOHk0djZTTS1BIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImQ1M2ExODYxLTM5YTgtNGM4Yi05ODUwLTRjMWI3YzMyY2ViMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MCwiZXhwIjoxNzU5NDIxMTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDM3MmYwNmMtZDhmOC00MmYyLWJhZWYtZjJjNTU2OWIxOWI0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.p5QhhWWlXBWLfb5A8aOi3zuQ3rUDXgTsdVTse8Lc3g97MTuPKWkYIwgWxYwI8iNKWgX5xHW6zDEfX-kgQhGnkNRlv_H1pBC0SjEbQk5z5solPcFSIUT5K-3DgBdL1s_S02qqgi1bjEGaxnE9dPC5Kj-C2QOL3GHnCu2NXT6Ed-RmgwjoW9KIAsIQR2wb5E5aJtRWlhRRHFuQpsO705VWREsGLIEmRiOH8b7aADNx033-NM3XsvEmVhLEGMATgZhcV2-FgsqPu32Q58s8onTesjuJsz368As3Vthtj1m7qRG0qsJ8iqYAUtvKerWtZqSiBtmvG8IF9KF_HaJNcEZZNQ'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "0460b468-443e-4a2d-a15c-53d316d56c10",
"standardRoleTypeId" : "b38efc50-cca0-43c9-8ed4-8afa11ede23a",
"createdBy" : "c053b18d-f8e1-42cb-a5e7-edadf075b52d",
"createdAt" : "2025-10-02T15:05:40.539917Z",
"updatedAt" : "2025-10-02T15:05:40.539917Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "f384c4fe-16b3-48de-b017-25c0dfa82026",
"resourceTypeId" : "54138c10-8a9f-4b5e-871d-2e203e9582aa"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 53 Admin - f384c4fe-16b3-48de-b017-25c0dfa82026"
}
Create Standard Role
POST /standard-roles
Authorization
This endpoint requires the following actions:
-
create
action on thestandard-role
resource type -
read
action on thestandard-role-type
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
standardRoleTypeId |
String |
true |
Client must have |
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
standardRoleTypeId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
path |
Array[Object] |
true |
Must not be null. |
path[].resourceId |
String |
true |
Must not be null. |
path[].resourceTypeId |
String |
true |
|
type |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-roles' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiI2aFdYWl9oUTc2RTFZZlFkOG42dEFBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjFmYmFkOTQ4LTI2OTUtNGQzNi1hNzZmLWNmZDlkZDA4MzE3NiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MCwiZXhwIjoxNzU5NDIxMTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNGM4MDEyZGItZDc1OS00MWMxLTgxNzctMTI5NWRmMzE4YTk2XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfSx7XCJpZFwiOlwiOWQ1MzY5ZDQtNmRmNy00YzQ1LWFiN2UtNzJiZjBlMTU3ZmRjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f9RhXfEmKjP0oGrKuDOTnh07DuE_rNeoQPPTFehlBWgICUa9DLI7R6z7ma7-LvVYS_IM05BCe78HOInNVJa34nhF81qKnt6ZH3rSA5O1UIjvVI4lkVRK0sg3-LgnJQo_CbAMpxgewVaOF21bdiezjHaB9ZhhtXOpNhDQHgi9X2KU9mAMaqPyIFai-V_SXPSKy91S2pj-2nNeSDL_4iKZnjJWjQYtcgU0KUoAB-OuQgNA0fl-Fy2i4C8jz-Iz9kDuJuiK_sNLcrPaAymyh9uXqX9uLeWaZxJO9SUd-oh09C-nq6ZzW_oe3bpmQMn5vJTdBmqrRnCUWhMf0Nh8ef502A' \
-d '{"standardRoleTypeId":"788594ba-ed73-4103-b1e7-4a6a7dbc17d0","path":[{"resourceId":"fede1fcb-8535-4a50-b3ff-ea483aeff8c1","resourceTypeId":"2d7b5903-22a8-4233-b26d-824fd7597056"}]}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 595
{
"id" : "c5376b0f-c955-4c5d-b2e6-f96567484aba",
"standardRoleTypeId" : "788594ba-ed73-4103-b1e7-4a6a7dbc17d0",
"createdBy" : "1fbad948-2695-4d36-a76f-cfd9dd083176",
"createdAt" : "2025-10-02T15:05:40.683301Z",
"updatedAt" : "2025-10-02T15:05:40.683301Z",
"deletedAt" : null,
"deletedBy" : null,
"path" : [ {
"resourceId" : "fede1fcb-8535-4a50-b3ff-ea483aeff8c1",
"resourceTypeId" : "2d7b5903-22a8-4233-b26d-824fd7597056"
} ],
"type" : "io.netfoundry.auth.domainv2.standardrole.StandardRole",
"_title" : "Test Type 55 Admin - fede1fcb-8535-4a50-b3ff-ea483aeff8c1"
}
Delete Standard Role
DELETE /standard-roles/{id}
Authorization
This endpoint requires delete
action on the standard-role
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-roles/52075de9-35f8-45bd-bcf3-2d6fe2f9de19' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJYQjVmWllCdWo5ejNBQnZfUURENnp3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijk5ZDM5Zjg5LTRkMzEtNDE0OC1hMGQ1LTQ0MDEzN2E3MzdmYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MCwiZXhwIjoxNzU5NDIxMTQwLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYWFiZmI5ODAtYWQ1Yi00ZDJlLThhMDYtNDI1NjI1Njc1MWIwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQwfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.lOtPrcrcdSNXwsFGbejvP08C_PIiISklDPssv1aH4qMIuLcF5UKDToT3OAre5GlRlIPktFHQRFh83MEYav8nvAmc2x9dIit7uVzi1w-sbSljTZH2ovwAe5o80lxx54pBF-XbyQlZIhNXnzZhFnKC5wcuf2FDTCpDB63d6XwtwLEyJx_K6KHlqUNFixVZS0jB-O-KVH5e2mmUfgnzenOruOIdkp5kvNbc0RybNoJm7TKqUwmGH_g_tYQnYX-tnZR_VVVgdfyAjUKQ7B9YHZt7w0xfYKy2ciGOY-ONPCTEIT0Q9mrWBjpnSL5i4XGqhsgeSvAtRUFQknTtTSwQLRnNPw'
Example response
HTTP/1.1 200 OK
Standard Roles Grants
Find Standard Role Grants
GET /standard-role-grants
Authorization
This endpoint requires read
action on the standard-role-grant
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
standardRoleId |
Object |
true |
|
standardRoleIds |
Object |
true |
Deprecated.. |
identityId |
Object |
true |
|
identityIds |
Object |
true |
Deprecated.. |
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].identityId |
String |
true |
Must not be null. |
[].standardRoleId |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-grants' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJILVp1a3JVdnlPUjZKcEZibnowZGNRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjhiNWU1YThjLWIzNGYtNDUyMy1iYmYzLWVhYThlYTIzZWU1OSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiM2FhZTBhOTQtNzhlMi00YmY4LThmMTYtNDFmNzVlNWFkMjFhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.IorEVTRc7J6lz6Xif1ehvUQUCkYL_8r_FjwLLJfom8QA8ABA-YfHnzlUSAXrcjh10SNWkqVNgzuctx7m8fh49VnMCi_3Ytcah6m0NXeDYisqQBAHN0dhWhZlWAUoC6KQXR4I8cCRB13kbfFHgt8NF-m_Ryd-CkLmkkyqtub44Wt9YmHc8L8q_Sh_dFNU7V2pxfD8WNMAne95RtKtgqPtAvpHTQUjC1EaucyJaLpI0Y8W73RONIFuas5owrSAJHJOhSawAsE7UDF0qWV53EROH29GJZbZXrkZPBKWec1KGS5oANFyQiom-XXSvfJrS5iHtvuaW2msUEL8O4YG03ckAg'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 990
[ {
"id" : "564209e4-3a96-40b2-9cfd-337c602d39c9",
"identityId" : "a8c1e49a-6d6c-42e7-8695-f894a34a386c",
"standardRoleId" : "615f8849-40b1-4a5a-95fa-5dc6324c3d8a",
"createdBy" : "19205e00-a08a-4af3-a00d-8863a73833b1",
"createdAt" : "2025-10-02T15:05:40.371659Z",
"updatedAt" : "2025-10-02T15:05:40.371659Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 51 Admin - 7429ba18-8d93-4442-bfb1-ed4131eb538a to identity a8c1e49a-6d6c-42e7-8695-f894a34a386c"
}, {
"id" : "c943c56f-4c7c-4ace-afb3-421f3ef7d3bc",
"identityId" : "54301ea4-4b77-4feb-b3ef-e952d338d04e",
"standardRoleId" : "96da86e3-5cb0-45c7-a7db-a08a30d81b9d",
"createdBy" : "859ef679-d2e0-4518-bf32-b738e3127663",
"createdAt" : "2025-10-02T15:05:41.136164Z",
"updatedAt" : "2025-10-02T15:05:41.136164Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 1b37322f-19bb-4232-9aad-050f7b4cbd08 to identity 54301ea4-4b77-4feb-b3ef-e952d338d04e"
} ]
Get Standard Role Grant
GET /standard-role-grants/{id}
Authorization
This endpoint requires read
action on the standard-role-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
standardRoleId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-grants/c260aaef-1b00-4829-8e85-b1c7d16f6f0a' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJRbmdjNTY3RWlSTlhIY1ZoNF9SeVVBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE1ZWU1ZTkwLWM4MWYtNGIyOC05MjEyLWFiMzBjN2E4ZTRmYSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZDlkZGFmODMtNzViMy00YjYwLWI1YzktNDQyNTAzNzMxMTJmXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.cNm8cceD9oRQRJSr_4LFU58FnEj6fJKs6NhirsI6AYvVVxIpvXz9_kWx0L5wFpfoFASoP1l0B3uHO0RdZwDnvtYIRhT0HnUi4UaMtcu00Ba1ZM0zkS2CfCf1SY2QiRgtDeUs84ODufmkP8BH_2BwP7fPjDHST3PPB7TIn3Wy7389TcuvVbEQVm0xO_k2MZ4dATa8CVleq4uQk0EPSbvgqeNtr9OPt7-OkCuk_vWIjjvzZXs5RSSQwVoJXIbF0dVDvX-5cZI9JhDO75kHOKLTM7SZl-Q-O4a2xb9GfWj1d2eTi6bQt5Lz6tOxTFVTpnXn5PqIf2ZPyd8iYNzTX2d5JA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "c260aaef-1b00-4829-8e85-b1c7d16f6f0a",
"identityId" : "8a931498-ecf3-472f-9ed3-e16c168a0fbc",
"standardRoleId" : "2d99e2ba-5810-4bdd-bced-b23ca5b924ce",
"createdBy" : "8921faee-4649-41f3-8c25-526298ed58be",
"createdAt" : "2025-10-02T15:05:41.292052Z",
"updatedAt" : "2025-10-02T15:05:41.292052Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 63 Admin - 580c86b4-8266-4f0d-9c23-4d9e2b320baf to identity 8a931498-ecf3-472f-9ed3-e16c168a0fbc"
}
Create Standard Role Grant
POST /standard-role-grants
Authorization
This endpoint requires the following actions:
-
create
action on thestandard-role-grant
resource type -
read
action on thestandard-role
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
standardRoleId |
String |
true |
Client must have |
identityId |
String |
true |
Must not be null. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
identityId |
String |
true |
Must not be null. |
standardRoleId |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-grants' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJCRlRpa3EtMXdfM2wyQzlNQUdMQ2d3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6Ijg1OWVmNjc5LWQyZTAtNDUxOC1iZjMyLWI3MzhlMzEyNzY2MyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMzVmYmI3NGQtZjRhNy00NGRmLWIyNDctZDNjY2UyNjk2ZGU0XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfSx7XCJpZFwiOlwiODk4ZTMwNzEtNWI4MC00ZjlmLTliODgtZjRhN2Q1ODYxZjIzXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.mShOOhmc-Ocos5GjxryiPzv1I9TLKEy9lAXzZl8fQ5sW62ohDSWIcB42Ez8pQu7_MI6obAEZQ8_pnYVXDvJx2hawJicXrfB1iUXjtbMxjDQMu1FbnrZ2PVnmKIN0RY9BcxzSuLt2XEffvR075mt5c_DoAhFOF_RP_mm57NVVp5C-0iFZddnz1Gqn1FGr8EmbTKuAPAjJg5hWgHipHqvzXmDjb-dkFfzgA_10WFlB5cFvZBmihd1HGMGLRglkO150uyjFdCglT1f8kmmY3fVtBqMvRvQjEnM29dnExXqGcQTuwd9KUuPVv3VaaafTXpT9MGh756TdjjfoRbPcoz5KcQ' \
-d '{"standardRoleId":"96da86e3-5cb0-45c7-a7db-a08a30d81b9d","identityId":"54301ea4-4b77-4feb-b3ef-e952d338d04e"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 492
{
"id" : "c943c56f-4c7c-4ace-afb3-421f3ef7d3bc",
"identityId" : "54301ea4-4b77-4feb-b3ef-e952d338d04e",
"standardRoleId" : "96da86e3-5cb0-45c7-a7db-a08a30d81b9d",
"createdBy" : "859ef679-d2e0-4518-bf32-b738e3127663",
"createdAt" : "2025-10-02T15:05:41.136164Z",
"updatedAt" : "2025-10-02T15:05:41.136164Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Grant Test Type 61 Admin - 1b37322f-19bb-4232-9aad-050f7b4cbd08 to identity 54301ea4-4b77-4feb-b3ef-e952d338d04e"
}
Delete Standard Role Grant
DELETE /standard-role-grants/{id}
Authorization
This endpoint requires delete
action on the standard-role-grant
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-grants/4ade94fb-c54e-4a9c-a527-372f63f11664' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJydXNBMWc0cFNIQWt1NjBSSHpIc3hRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImI2ODJiNDU3LTMxNjItNGFjOC04Y2IzLTZiZTIyYTgyODNmMCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDU5NzRiNjQtMWU1Mi00MzI0LWI4ZjItMThlY2EzYTQ1YzM5XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.f5iCw1i6u9ijvf2fItaxSQUdgblnHLcfA12vo9DzIpBge_MZBuQa1GoJSvuLv3cHaVfxI6gvshllQAA5BuP3hsKko1xTXdgVEQF6D78U0egw3s3q_9Cu4j9r-AVWDXun_UlRaIfckpTL0GPx7vknwbHyNXcKZejs8FTcznzpHtS-vlIOqRNmfwsCjZtzQwIytv9xD4BV7WM0C_pj0bZ9KteEciTu50fLys3ROu7XT1ALdJXteu7JIgwUY-icQR6e89StX1KZqadRunEWpuGAKN-NDMBbzNl0j-8KsPY0melsJRY2J03XPAZ0XG4b3FDlzTWNBwDXtpX1JDzvqMRRYA'
Example response
HTTP/1.1 200 OK
Standard Role Types
Find Standard Role Types
GET /standard-role-types
Authorization
This endpoint requires read
action on the standard-role-type
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
resourceTypeId |
Object |
true |
|
resourceTypeIds |
Object |
true |
Deprecated.. |
authorizationStrategyName |
Object |
true |
|
authorizationStrategyNames |
Object |
true |
Deprecated.. |
includedByStandardRoleTypeId |
Object |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceTypeId |
String |
true |
Must not be null. |
[].authorizationStrategyName |
String |
true |
Must not be null. |
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJjOEwyZ05tQlFLdGhldEQzd0F0MEpRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjA4ZTgwZWFjLTFmOGQtNDRjNy1hM2JiLTY2Yjk2MWMyZTg1ZCIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYjdjNWY5MzktM2Q0MC00MzMzLTgyYTAtMjNmZDJkMDE4ZmU1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.jcOzj65j29CfxXk0Fu9BfYFfc2PqC6pHeREBZx-eDc9JcwhGYDvMKDjtlLnOh9J9wI_FeewSR2Y_0ZpEwbM0kWV-Krmb1q_ybcbGt0jH38lJzW4FEtnD29N19bqoDFL7yGnzbSV2F2Q_bEyG6apRZXEcLACgoxIXAjo6bKKQbp4yfC9B1nm3ObzSF5_JJLgmSFAV1T8pwQaN3dbgxANR6ykTT_9SZ1j_TzViJuCfACiRH6STxUO6rxaW5DVbMBIFpqMEalo7_YUY-PDWG_yVxdTX7ge5saxDri96oS1W_vU-SmNccu6mKqdw3sLczjQBh0sxqcuTLKJ4hUjhlPjZ4A'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1024
[ {
"id" : "341d833b-6807-4211-9bf6-106c9c936294",
"resourceTypeId" : "d206c4f8-b768-446c-b70a-3414db19bfa1",
"authorizationStrategyName" : "Admin",
"createdBy" : "1135fb99-af43-40cb-a604-2661fba7318e",
"createdAt" : "2025-10-02T15:05:40.855943Z",
"updatedAt" : "2025-10-02T15:05:40.855943Z",
"_title" : "Test Type 57 Admin"
}, {
"id" : "a3b8d405-d094-4696-957b-03045e36e03d",
"resourceTypeId" : "f42550b3-a5f4-406f-808d-c445d4f18c80",
"authorizationStrategyName" : "Admin",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:06.155085Z",
"updatedAt" : "2025-10-02T15:05:06.155085Z",
"_title" : "Network Admin"
}, {
"id" : "bafd2c41-d1d8-43ed-9490-0f3f313f09ef",
"resourceTypeId" : "ac00cfa5-41a2-4707-9b7f-950de6f52ea7",
"authorizationStrategyName" : "Read-Only",
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:06.835361Z",
"updatedAt" : "2025-10-02T15:05:06.835361Z",
"_title" : "Custom Role Read-Only"
} ]
Get Standard Role Type
GET /standard-role-types/{id}
Authorization
This endpoint requires read
action on the standard-role-type
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceTypeId |
String |
true |
Must not be null. |
authorizationStrategyName |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types/b69449b0-9b8b-469d-9695-9b030769845e' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiIxc3ZQYXVtTjVWZDBFdURLUFlpalhBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjI0ZmI0MzIwLTk5YzUtNGY2OS04MDk0LTIxMGJjMWRjOGU2YyIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNDMwMWFlM2UtMDk3Ni00ZjA1LTllYTItMzc1ZDgyYmRjZmJjXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.NajD-z82pxmuojrIxcB7y2d-U5okvYYKVIL8OGnW_9Qf1lSRPJNX-YSGyLIz27VKPABvlTDYKR8dzZB0jvaFXipylq-i5eVJ0rKZezGUa8XAowE5ezeWf83OZ_Zq4EYNCe6gq4ibQxCUfEz-4Mn4bej8buNhIaq7PBrFr5w5-lXpPKncxdWqoICCMEBToi3eX6gl7ezD1U8qW_iL1Yya5bKd7jOZ_M0iAeV7IJblR4wgGQxR0hKzobI5A2svD7atZBHqELvLDsOJn3jZQZhaOXcMHiZ4kGHcLcg2hpNAtvBfyd1CC9CWeWqqsnlenFzvD4dFkzN-2MCJvdwcSnBW_w'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 338
{
"id" : "b69449b0-9b8b-469d-9695-9b030769845e",
"resourceTypeId" : "28ea8a53-c5b8-4992-96d0-5fc39e3a8ba7",
"authorizationStrategyName" : "Admin",
"createdBy" : "fe481568-e547-441c-9d4f-4ae7ee70464a",
"createdAt" : "2025-10-02T15:05:41.603457Z",
"updatedAt" : "2025-10-02T15:05:41.603457Z",
"_title" : "Test Type 67 Admin"
}
Create Standard Role Type
POST /standard-role-types
Authorization
This endpoint requires the following actions:
-
create
action on thestandard-role-type
resource type -
read
action on theresource-type
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
resourceTypeId |
String |
true |
Client must have |
authorizationStrategy |
String |
true |
Must not be null. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceTypeId |
String |
true |
Must not be null. |
authorizationStrategyName |
String |
true |
Must not be null. |
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/standard-role-types' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiI4aXJ3TjNGcUJGaGVvbEhUaWo2MjlBIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjZlMTc3N2M5LTk2ZWQtNDExNC05MTAxLTM5MWIyZjA1MTMxMiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzU0MSwiZXhwIjoxNzU5NDIxMTQxLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjI0MGRhNjU5LWZiMTYtNDE4Ny04OTU3LTZjM2I1NmE1OGJkZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOH0se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImU1NjljMTU4LWZmYWMtNDlmNS1iNjEzLTVkODMyNGYzNzY0Y1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUzOX1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiYTBlYTk1ZDMtYjAyNy00YTNlLWJjYTgtZDk2ZTBmY2Q4OTQyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfSx7XCJpZFwiOlwiZjg0ZWMzMzEtOTY0My00ZGVmLWI3YTYtNmM4M2QyZTE1NTkyXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTQxfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.F1_igDtQOMlHmNCQYVBlzJJueQ98funGLCcADV9y8huusai52GqHd4ImOGzAZtPgUFVFMuHPrfLLzyObtYGiRzb0Df7-QLGHSgarqjjgWTW9g47ZomnqZpdH7py4NndMVnUygvxeVnT4tgQ0X46TLs_VM9y9hUgiIq34OLvrIIdhaPA0WS2QaQjSaKMIGe_n2lZQ6ngQONLah7UdYMYZt6gZIaUBe1qocChr-oc_bEz7Tzyi-V5-QJHjnTArvmWLV2ZPaqZhJoBlt4BCqwndetM3hIBoaHyGUpWxxhnv36NZhiznwc_h1Oocmhhj0LoFpf4cvS4nsud5BiD7wmhVzA' \
-d '{"resourceTypeId":"453b0e75-783f-4e7a-908f-e6cdd7a7b6de","authorizationStrategy":"Admin"}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 335
{
"id" : "2a01590f-5770-4071-801e-e4006c06c125",
"resourceTypeId" : "453b0e75-783f-4e7a-908f-e6cdd7a7b6de",
"authorizationStrategyName" : "Admin",
"createdBy" : "6e1777c9-96ed-4114-9101-391b2f051312",
"createdAt" : "2025-10-02T15:05:41.525422Z",
"updatedAt" : "2025-10-02T15:05:41.525422Z",
"_title" : "Test Type Admin"
}
Resource Action Inclusions in Standard Roles
Find Action Inclusions
GET /action-inclusions
Authorization
This endpoint requires read
action on the action-inclusion
resource type.
Path parameters
No parameters.
Query parameters
Parameter | Type | Optional | Description |
---|---|---|---|
resourceActionId |
Object |
true |
|
authorizationStrategyName |
Object |
true |
|
isDeleted |
Boolean |
true |
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceActionId |
String |
true |
Must not be null. |
[].authorizationStrategyName |
String |
true |
Must not be null. |
[].includeWhenAbove |
Boolean |
true |
|
[].includeWhenAt |
Boolean |
true |
|
[].includeWhenBelow |
Boolean |
true |
|
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJJanBkemp0bWtFZFhEbDVyekdXS3h3IiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjE3MDdjMGMwLWQ2ZjYtNDIzMS04Y2IzLTNmNDNkZGI3OTc3ZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzMiwiZXhwIjoxNzU5NDIxMTMyLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiNTYzM2FmNWItOTJiOC00ODNjLWEwOGYtY2E2Y2NjZjAwYjQwXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTMyfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.zNXlvbxugF00s27XgsCve1FgYtUQ2qD7jZVHe74lH_cHtWsrXkPKbqcUEFdLGWfqt1SeGiqaHJHZwbD3Wvdkk-R7-ZvbkYt46xgm28uHZ9fFZyCAEHRss4BqqB0g_bICUDpgr7dDz8OULZu81t4ZMzhzbTDLCHIfQUK47CLJFtQpxjAURZYouhJEvv2j2DoAGjLNJW_qFULSCnazJO2wk6t0IdY_UXNpoIIRbMhLscI2GsUQEZkGasQNsMqP9aC_D9bGyG2E_o7898tPySiWHOSXZAz4fmrxidkFXmATg_gbfQfcve1BIF0Y2wKS7iFum_Cy69THv0Vo8RRtVd08ZA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1579
[ {
"id" : "55ba4f7a-146f-4435-8645-cc6144869c89",
"resourceActionId" : "be0bbc32-5fe7-4c68-a887-643ce8079be4",
"authorizationStrategyName" : "Contributor",
"includeWhenAbove" : false,
"includeWhenAt" : false,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:07.160595Z",
"updatedAt" : "2025-10-02T15:05:07.160595Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Update Endpoint Group in Contributor Standard Roles"
}, {
"id" : "54c19f53-82e1-486e-9e8b-ebbb9627615b",
"resourceActionId" : "52b12ba3-a182-409a-a56b-887c36a152eb",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : false,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:07.731028Z",
"updatedAt" : "2025-10-02T15:05:07.731028Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Delete Identity Session in Admin Standard Roles"
}, {
"id" : "2a254d71-e560-4e4f-baef-7631b1038bdb",
"resourceActionId" : "e0ffeaa8-205c-4057-a05c-21c8b1f46625",
"authorizationStrategyName" : "Read-Only",
"includeWhenAbove" : true,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "0ab1b47d-a5de-4f39-a3bd-7b130cacf401",
"createdAt" : "2025-10-02T15:05:06.746263Z",
"updatedAt" : "2025-10-02T15:05:06.746263Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Read Action Inclusion in Read-Only Standard Roles"
} ]
Get Action Inclusion
GET /action-inclusions/{id}
Authorization
This endpoint requires read
action on the action-inclusion
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
Path | Type | Optional | Description |
---|---|---|---|
id |
String |
true |
Must not be null. |
resourceActionId |
String |
true |
Must not be null. |
authorizationStrategyName |
String |
true |
Must not be null. |
includeWhenAbove |
Boolean |
true |
|
includeWhenAt |
Boolean |
true |
|
includeWhenBelow |
Boolean |
true |
|
createdBy |
String |
true |
Must not be null. |
createdAt |
String |
true |
Must not be null. |
updatedAt |
String |
true |
Must not be null. |
deletedAt |
String |
true |
|
deletedBy |
String |
true |
|
_title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions/c5b5623b-6ddb-40b2-938c-007962e14a0c' -i -X GET \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJ3SHRYNl9iM21BOXpDZ1Fwbi1LWUxRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjdiNTUyNzZjLWE1YWQtNGE0Zi1hMGJiLTU2M2Y3NGYwMDYzZiIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzMywiZXhwIjoxNzU5NDIxMTMzLCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiMjVkNGYwMTgtMWEzZC00YWVhLWI0ZjEtODcwZGM1N2M0NDJkXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTMzfV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ETkVWGnvaPAELpcMRBnpdmJQqGbWJWJaC72pJC_iPj3imVZFutn4Vv39vBbBqA7qsPmK7dHy8cjoTT-hSyzqiiAMZOTFXwRBRC8W4kHcYGK_E-P7sMDh9nVPBuYkQTRhevWdmU0LLLlpwxY293S9asdcRDTfV5KrrTm4Tmlcmpv70GRr908yceXCf_bpzSxOxwjHbScmzS42EUP2dEu518G1dQ9YADWF9JGGdr5NFj1ae4o9CEsI-5vQzvVKNZ4NpARKk9I4M7xgTDxtHNCHhmkJ0RAPZ5l78jhSWpK7t9Dj-7hubXII5OswlmSoJ_co2Wzo_F7NMLimaPzjWOyepA'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 522
{
"id" : "c5b5623b-6ddb-40b2-938c-007962e14a0c",
"resourceActionId" : "63eb2911-49e5-4b52-84cf-c682b9f6e6de",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "98b20dc4-f869-4a2b-87d6-2ea2bd43a186",
"createdAt" : "2025-10-02T15:05:33.895616Z",
"updatedAt" : "2025-10-02T15:05:33.895616Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Test Action 15 Test Type 14 in Admin Standard Roles"
}
Create Action Inclusion
POST /action-inclusions
Authorization
This endpoint requires the following actions:
-
create
action on theaction-inclusion
resource type -
read
action on theresource-action
resource type
Path parameters
No parameters.
Query parameters
No parameters.
Request fields
Path | Type | Optional | Description |
---|---|---|---|
resourceActionId |
String |
true |
Client must have |
includeWhen |
Map |
true |
Must not be empty. |
Response fields
Path | Type | Optional | Description |
---|---|---|---|
[].id |
String |
true |
Must not be null. |
[].resourceActionId |
String |
true |
Must not be null. |
[].authorizationStrategyName |
String |
true |
Must not be null. |
[].includeWhenAbove |
Boolean |
true |
|
[].includeWhenAt |
Boolean |
true |
|
[].includeWhenBelow |
Boolean |
true |
|
[].createdBy |
String |
true |
Must not be null. |
[].createdAt |
String |
true |
Must not be null. |
[].updatedAt |
String |
true |
Must not be null. |
[].deletedAt |
String |
true |
|
[].deletedBy |
String |
true |
|
[]._title |
String |
true |
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions' -i -X POST \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJqOFJhWFRHQmQ2eXpQLVduMy04VVJRIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6ImU5NzE4NTU2LTE0OTUtNGJhZC1hMzkzLTEwMWQ0YTZjZDViZSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNCwiZXhwIjoxNzU5NDIxMTM0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiZWM4NTgyZGUtZWE4MS00N2ZjLTlkYjctZDk4ZjQ0OTFmMWRhXCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM0fSx7XCJpZFwiOlwiYTVhZjk3YTUtNTM0NS00NTFkLTg0MmUtM2JkYjFlMTFjOTY4XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.ykQ4Eyn4yEwj78zaPIX-x_peTi3gn2_rUbkxQdg3oK2794J4UdGCTwekQG1irulSGDrpVxqM7SaGLU6F2y9svLzyDxVwxpH6xUoa7HWXoEpXCOHUe_jb0gMIZB8naCv1qZZGrpzkIVq0OiHHU1GXOwnXQcbCEMMQmvWW3TWF3Q9NC9iKPX6B-Hga2jv4bjxZUvDM8W1SWfLSvxL8-INkVI0JGJ4u2Y62YrqpBpQ8jJtdDb860zEv6qJCZVCqqIYGZRF_kgw_C0AS9Vsn7jOp8f_JkcUzJYazvhX13CWlQLzRrEINyF7eAePPAkpNLQ2-vzkIKQf_IU7cr6M5dgMy0Q' \
-d '{"resourceActionId":"2ce71e60-f567-4865-9039-1175adda84fe","includeWhen":{"Admin":{"above":false,"at":true,"below":true}}}'
Example response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 526
[ {
"id" : "e3f0c2f8-99e1-463b-bbe0-a2042371b135",
"resourceActionId" : "2ce71e60-f567-4865-9039-1175adda84fe",
"authorizationStrategyName" : "Admin",
"includeWhenAbove" : false,
"includeWhenAt" : true,
"includeWhenBelow" : true,
"createdBy" : "e9718556-1495-4bad-a393-101d4a6cd5be",
"createdAt" : "2025-10-02T15:05:34.453838Z",
"updatedAt" : "2025-10-02T15:05:34.453838Z",
"deletedAt" : null,
"deletedBy" : null,
"_title" : "Inclusion Rules for Test Action 21 Test Type 20 in Admin Standard Roles"
} ]
Delete Action Inclusion
DELETE /action-inclusions/{id}
Authorization
This endpoint requires delete
action on the action-inclusion
resource type.
Path parameters
Parameter | Type | Optional | Description |
---|---|---|---|
id |
Object |
false |
Query parameters
No parameters.
Request fields
No request body.
Response fields
No response body.
Example request
$ curl 'https://gateway.netFoundry.io/auth/v1/action-inclusions/1e3357dd-f124-47e0-a6c3-e9a9a59d6d98' -i -X DELETE \
-H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImIxYjIyNmZmLTZlOGMtNDIzZC1iNDYxLWFjMWVjNjlmZmI4OSJ9.eyJqdGkiOiJnRkFRSy1NSjc3OEpqTFNScmE3ZzVnIiwiaXNzIjoiTmV0Rm91bmRyeSIsInN1YiI6IjQyOWM3MjhhLWQ3NjgtNDBjZC1hNTVjLTVkNDNkMTdhZWM3YSIsImF1ZCI6ImlvLm5ldGZvdW5kcnkuYXV0aCIsImlhdCI6MTc1OTQxNzUzNCwiZXhwIjoxNzU5NDIxMTM0LCJncmFudHMtc3VwZXIiOiJbXSIsImdyYW50cy1jdXN0b20iOiJbXSIsImdyYW50cy1wdWJsaWMiOiJbe1wiaWRcIjpcIjRjOGUwZDUzLWQyZWUtNDRhNS1hOGM4LWI0OWM1NTU0ODQwMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImE1NTU3OWVmLThjZDYtNDFhOC1hNGJkLWI3MzUzMWRjZTJmZVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOX0se1wiaWRcIjpcImZjYTJmZmU4LWUxMzQtNGUxMi1iM2ZhLWQyMTJlYTI4ODBmMFwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcImEzZDMzNzg1LTk5M2UtNDRkNi1iNmQwLTA5OTU0NTRhYzAzYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjE2NjRhOTBlLTkzNDUtNDQ3YS1iMjA1LTEwZmQwMTkwNTdkN1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjU0NGEwNThiLTNlZmItNGQ2My05NzcwLThiNjRkMWMzYTFkYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn0se1wiaWRcIjpcIjZkMDNiMGMxLWQ4NWItNGMyOC1hY2I4LTUzOTk0YzgxZGUzZlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwOH0se1wiaWRcIjpcIjUwZjhmNmY2LWY2NDItNGRjZS1iZDIwLTIwYjQ5MTQ0NDY2YVwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwN30se1wiaWRcIjpcIjZkMmI2ZDkwLTQ4NjktNGNkMS1hYzRjLTRjMzNlOTM1ZjRiM1wiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUyM30se1wiaWRcIjpcIjc4MDBmMmIxLTRjMmQtNDJhYi1iNWMyLWI4ZDRjZTc0ZWIxYlwiLFwibGFzdE1vZGlmaWVkXCI6MTc1OTQxNzUwNn1dIiwiZ3JhbnRzLWFjdGlvbiI6Ilt7XCJpZFwiOlwiOTc2NzRlMzEtNjUxMi00NzBmLWJkNWYtYWEwNWI5YTQwMTM1XCIsXCJsYXN0TW9kaWZpZWRcIjoxNzU5NDE3NTM0fV0iLCJncmFudHMtc3RhbmRhcmQiOiJbXSJ9.zKVNBKLZ48nob3Q6O7EgNGlar_ZH4vwE_mmAabss-Sf9bryR-HGzi5hSQnxTLx9RndITK4PiGp8XhTtM8sh4lEQsUCrtYwo_9EXbMEAG7HxH3WrQ4GjjrAh7KFpMUBe7oBJtjCoptXsLIgTTscrjdyGc1aUnoj64j1ldS8iBtBays4bGN87XpLaYPqHWYD8lcXcHCk1Ag9n2Y2xuWwvxnox0tzgRQXYA2ZlzSKEDAjb4F3gMxb-MrIrtXLDJ1jVNpOEfDpADt3Cvmx70GcoZNbD2HlRN_hYQPcRSDvVAZ1uiAyaI1O8ylAbJCT_8DdPXBaU_O_fDsijQEpVn_ZQhGA'
Example response
HTTP/1.1 200 OK